strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/odk/docs/tools.html
Julien Nabet 94da114cd8 tdf#160180: bump copyright year to 2024 
Change-Id: I466b8f86e8a53a238ed2ce2d2b053dc519ff8eed
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164794
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Tested-by: Julien Nabet <serval2412@yahoo.fr>
2024-03-13 22:55:18 +01:00

906 lines
42 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<html>
<head>
<title>LibreOffice %PRODUCT_RELEASE% SDK - Development Tools</title>
<link rel="stylesheet" type="text/css" href="sdk_styles.css"/>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
</head>
<body>
<a name="tools"></a>
<div id="BgContainer">
<div id="Container">
<div id="TopHeader">
<a id="Logo" href="http://www.libreoffice.org/" title="Go to the Home of LibreOffice and the LibreOffice Community page"></a>
<p id="HeaderTagLine">
Software Development Kit %PRODUCT_RELEASE%
</p>
</div>
<div class="clear">
</div>
<div id="Layout">
<div class="typography">
<h1>
Development Tools
</h1>
<table class="table1" cellpadding="0">
<tr>
<td colspan="3"><img class="nothing10" src="images/nada.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="3"><img class="nothing1" src="images/nada.gif"/></td>
</tr>
<tr>
<td>
<table class="table3">
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#unopkg" title="link to the unopkg tool description">unopkg</a></td>
<td class="content87">The new UNO package deployment tool. It comes
with the office installation and can be found in the program
directory of the office installation.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#unoexe" title="link to the uno tool description">uno</a></td>
<td class="content87">Tool to provide a UNO runtime environment and
provide configured (deployed) or single components. This tool
comes with the office installation and can be found in the program
directory of the office installation.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#unoidl-write" title="link to the unoidl-write tool description">unoidl-write</a></td>
<td class="content87">The UNOIDL compiler, generates a common
binary type library format as base for all codemaker tools and
the UNO runtime type library.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#unoidl-read" title="link to the unoidl-read tool description">unoidl-read</a></td>
<td class="content87">Tool to view type library data
in a human readable manner.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#cppumaker" title="link to the cppumaker tool description">cppumaker</a></td>
<td class="content87">Tool for generating C++ code for the UNOIDL
types stored in a type library.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#javamaker" title="link to the javamaker tool description">javamaker</a></td>
<td class="content87">Tool for generating Java class files for the
UNOIDL types stored in a type library.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#climaker" title="link to the climaker tool description">climaker</a></td>
<td class="content87">Tool for generating CLI assemblies for the
UNOIDL types stored in a type library (windows only).</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#uno-skeletonmaker" title="link to the uno-skeletonmaker tool description">uno-skeletonmaker</a></td>
<td class="content87">Tool for dumping type definitions on stdout or generating complete code skeletons for Java/C++.</td>
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#regview" title="link to the regview tool description">regview</a></td>
<td class="content87">Tool to view the content of a legacy registry file
in a human readable manner. Special support for type library
nodes. <b>Note:</b> Since OpenOffice.org 3 it is no longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="unopkg"/>unopkg</td>
<td align="right">
<a style="a:link:visited #FFFFFF;" href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a></td>
</tr>
<tr>
<td colspan="3">
<p>'unopkg' is a tool for easy deployment of UNO packages in an existing
office installation. UNO packages are UNO components (single libraries or
Jar files or more complex zip files that contain one or more libraries|
Jar files, type libraries and configuration items), scripts and
LibreOffice %PRODUCT_RELEASE% Basic libraries as zip package. 'unopkg' is not part of the
SDK but comes with the office directly and is a development tool as well
as an end user tool to deploy extension into an office installation.</p>
<p>More details concerning deployment and this tool can be found in the
Developer's Guide: <a href="https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions#unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">Extension Manager - <i>unopkg</i></a>.</p>
<p><b>Note:</b> This tool works only in the <i>&lt;office&gt;/program</i>
directory!</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>
unopkg add &lt;options&gt; package-path...<br/>
unopkg remove &lt;options&gt; package-name...<br/>
unopkg list &lt;options&gt; package-name...<br/>
unopkg reinstall &lt;options&gt;<br/>
unopkg gui<br/>
unopkg -V<br/>
unopkg -h<br/>
</code></b>
</blockquote>
<p class="head2">Sub-commands:</p>
<table class="table4">
<tr>
<td class="cell15"><code>add</code></td>
<td class="cell85">add packages</td>
</tr>
<tr>
<td class="cell15"><code>remove</code></td>
<td class="cell85">remove packages by name</td>
</tr>
<tr>
<td class="cell15"><code>reinstall</code></td>
<td class="cell85">expert feature: reinstall all deployed
packages</td>
</tr>
<tr>
<td class="cell15"><code>list</code></td>
<td class="cell85">list information about deployed packages</td>
</tr>
<tr>
<td class="cell15"><code>gui</code></td>
<td class="cell15">raise Package Manager Graphical User Interface
(GUI)</td>
</tr>
</table>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-h, --help</code></td>
<td class="cell85">show this help on the command line</td>
</tr>
<tr>
<td class="cell15"><code>-V, --version</code></td>
<td class="cell85">shows version information
</td>
</tr>
<tr>
<td class="cell15"><code>-v, --verbose</code></td>
<td class="cell85">dump verbose output to stdout</td>
</tr>
<tr>
<td class="cell15"><code>-f, --force</code></td>
<td class="cell85">force overwriting existing packages</td>
</tr>
<tr>
<td class="cell15"><code>--log-file &lt;file&gt;</code></td>
<td class="cell85">custom log file; default:
<i>&lt;cache-dir&gt;/log.txt</i>.</td>
</tr>
<tr>
<td class="cell15"><code>--shared</code></td>
<td class="cell85">expert feature: operate on shared installation
deployment context; run only when no concurrent Office process(es) are
running!</td>
</tr>
<tr>
<td class="cell15"><code>--deployment-context &lt;context&gt;</code>
</td>
<td class="cell85">expert feature: explicit deployment context</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="unoexe"/>uno</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The UNO-starter is for running a component or service process, and
providing a runtime environment. Raising a component might look like
this </p>
<p><code>[c:\] uno.exe -c MyComponent -l mycomp.dll -env:URE_MORE_SERVICES=myservices.rdb -env:URE_MORE_TYPES=mytypes.rdb
-- foo bar</code></p>
<p>or</p>
<p><code>[c:\] uno.exe -s foo.bar.FooBarService -env:URE_MORE_SERVICES=myservices.rdb -env:URE_MORE_TYPES=mytypes.rdb
-- foo bar</code></p>
<p>The starter loads the component and instantiates it. The component
must export the interface <a href="%DOXYGEN_PREFIX1%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XMain.html" title="link into the IDL reference to the interface com.sun.star.lang.XMain">com.sun.star.lang.XMain</a>:</p>
<p>
<code>interface XMain : com::sun::star::uno::XInterface <br/>
{ <br/>
&nbsp;&nbsp;&nbsp; /** This method is called to run the component.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @param aArguments command line arguments <br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @return process error code to be returned to system <br/>
&nbsp;&nbsp;&nbsp; */ <br/>
&nbsp;&nbsp;&nbsp; long run( [in] sequence&lt; string &gt; arguments ); <br/>
};
</code>
</p>
<p>Method run() will be called and returns the error code given, back
to the system. If the uno starter is executed with the -u (URL) option,
then XInitialization is used instead of XMain. The -u option is described
later.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>uno (-c&lt;ComponentImplementationName&gt; -l &lt;LocationUrl&gt;
| -s &lt;ServiceName&gt;) <br/>
[-u uno:(socket[,host=&lt;HostName&gt;][,port=&lt;nnn&gt;]|pipe[,name=&lt;PipeName&gt;]);iiop|urp;&lt;Name&gt;<br/>
[--singleaccept] [--singleinstance]] <br/>
[-- &lt;Argument1 Argument2 ...&gt;]
</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>&lt;HostName&gt;</code></td>
<td class="cell85">Specifying a host name might be necessary to
distinguish the network interface to be used,if a machine is part of
two networks.</td>
</tr>
<tr>
<td class="cell15"><code>&lt;PipeName&gt;</code></td>
<td class="cell85">Name of a named pipe.</td>
</tr>
<tr>
<td class="cell15"><code>&lt;Name&gt;</code></td>
<td class="cell85">Identifier for demanded called component
instances.</td>
</tr>
<tr>
<td class="cell15"><code>--singleaccept</code></td>
<td class="cell85">The uno starter will accept one connection,
provide the component instance and die.</td>
</tr>
<tr>
<td class="cell15"><code>--singleinstance</code></td>
<td class="cell85">The uno starter will accept any number of
connections, but will provide the same single component instance any
time instead of creating a new instance for each connection.</td>
</tr>
</table>
<p><b>Service <a href="%DOXYGEN_PREFIX1%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1bridge_1_1UnoUrlResolver.html" title="link into the IDL reference to the service com.sun.star.bridge.UnoUrlResolver">com.sun.star.bridge.UnoUrlResolver</a></b></p>
<p>You can easily connect to a server started with the
<code>-u (url)</code> option by using this service, giving the same url
to resolve. The service provides you an instance from remote.</p>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="unoidl-write"/>unoidl-write</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>'unoidl-write' is the new UNOIDL compiler, replacing the former idlc and regmerge tools. It is a full featured compiler used
to check UNODL type definitions and transform valid type definitions
into a binary type library format, which is later used by all codemaker
tools. It is also used as a dynamic type library for UNO at runtime.<br/>
You can find a syntax description for UNOIDL <a href="https://wiki.documentfoundation.org/Documentation/DevGuide/UNOIDL_Syntax_Specification" title="link to the &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
<p><b>Note:</b> unoidl-write produces a new binary type library format that is
different from the legacy format that was produced by idlc and regmerge. While
recent versions of LibreOffice are still able to read the old format, versions of
LibreOffice prior to LibreOffice&nbsp;4.1 were not able to read the new format.
Thus, if you use this SDK to generate a LibreOffice extension that contains a type
library file produced by unoidl-write, you should specify a
<code>LibreOffice-minimal-version</code> of at least&nbsp;4.1 for that extension
(see <a
href="https://wiki.documentfoundation.org/Development/Extension_Development#Compatibility_notes">&ldquo;Extension
Development: Compatibility notes&rdquo;</a>).</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>unoidl-write [&lt;registries&gt;] [@&lt;entries file&gt;] &lt;unoidl file&gt;</code></b>
</blockquote>
<table class="table4">
<tr>
<td class="cell15"><code>&lt;registries&gt;</code></td>
<td class="cell85">each <code>&lt;registry&gt;</code> is either a new- or
legacy-format .rdb file, a single .idl file, or a root directory of an .idl
file tree.</td>
</tr>
<tr>
<td class="cell15"><code>@&lt;entries file&gt;</code></td>
<td class="cell85">a UTF-8 encoded file containing zero or more
space-separated names of (non-module) entities to include in the output; if
omitted, the output defaults to the complete content of the last
<code>&lt;registry&gt;</code>, if any.</td>
</tr>
<tr>
<td class="cell15"><code>@&lt;unoidl file&gt;</code></td>
<td class="cell85">specifies the name of the output file.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="unoidl-read"/>unoidl-read</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>'unoidl-read' is a tool to show the contents of a type library. The tool writes the
content in a human readable manner to stdout.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>unoidl-read [--published] [--summary] &lt;registries&gt;</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>--published</code></td>
<td class="cell85">if specified, only published entities (plus any non-published
entities referenced from published via any unpublished optional bases) are written
out.</td>
</tr>
<tr>
<td class="cell15"><code>--summary</code></td>
<td class="cell85">if specified, only a short summary is written, with the type and
name of one entity per line.</td>
</tr>
<tr>
<td class="cell15"><code>&lt;registries&gt;</code></td>
<td class="cell85">one or more <code>&lt;registry&gt;</code> elements, where each
is either a new- or legacy-format .rdb file, a single .idl file, or a root
directory of an .idl file tree. The content of the last
<code>&lt;registry&gt;</code> is written out. The other
<code>&lt;registry&gt;</code> elements are only used to look up dependencies.</td>
</tr>
</table>
</td>
</tr>
</table>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="cppumaker"/>cppumaker</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The 'cppumaker' generates a C++ representation for idl types. The
cppumaker works on a typelibrary, which is generated by the UNOIDL
compiler (<a href="#unoidl-write" title="link to the unoidl-write tool description">
unoidl-write</a>). It generates the output for all specified types and for all
types the specified types depend on.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>cppumaker [-options] file_1 ... file_n</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-O&lt;path&gt;</code></td>
<td class="cell85">path describes the root directory for the
generated output. The output directory tree is generated under this
directory.</td>
</tr>
<tr>
<td class="cell15"><code>-T&lt;name&gt;<br/>
|-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
<td class="cell85">name specifies a type or a list of types. The
output for this type and all dependent types are generated. If no '-T'
option is specified, then output for all types is generated. It is also
possible to use a wildcard 'xy.*' to generate a complete module
inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
option. Example: 'com.sun.star.uno.XInterface' or
'com.sun.star.uno.*' are valid types.
</td>
</tr>
<tr>
<td class="cell15"><code>-B&lt;name&gt;</code></td>
<td class="cell85">name specifies the base node. All types are
searched under this node. Default is the root '/' of the registry
files.
<br/>
<i>This option has been removed in LibreOffice 4.1.</i>
</td>
</tr>
<tr>
<td class="cell15"><code>-L</code></td>
<td class="cell85">UNO type functions are generated lightweight, that
means only the name and typeclass are given and everything else is
retrieved from the type library dynamically. The default is that UNO
type functions provides enough type information for bootstrapping C++.
'-L' should be the default for external components.</td>
</tr>
<tr>
<td class="cell15"><code>-C</code></td>
<td class="cell85">UNO type functions are generated comprehensive
that means all necessary information is available for bridging the
type in UNO.
</td>
</tr>
<tr>
<td class="cell15"><code>-G</code></td>
<td class="cell85">generate only target files which do not
exist.</td>
</tr>
<tr>
<td class="cell15"><code>-Gc</code></td>
<td class="cell85">generate only target files whose content will
be changed.</td>
</tr>
<tr>
<td class="cell15"><code>-X&lt;name&gt;</code></td>
<td class="cell85">extra types, which are not be taken into account
for generation.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="javamaker"/>javamaker</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The 'javamaker' generates the appropriate Java class file for each idl
type. The javamaker works on a typelibrary which is generated by the
UNOIDL compiler (<a href="#unoidl-write" title="link to the unoidl-write tool description">
unoidl-write</a>). It generates the output for all specified types and for all
types the specified types depend on.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>javamaker [-options] file_1 ... file_n -Xfile_n+1 -Xfile_n+2</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-O&lt;path&gt;</code></td>
<td class="cell85">path describes the root directory for the
generated output. The output directory tree is generated under this
directory.</td>
</tr>
<tr>
<td class="cell15"><code>-T&lt;name&gt;|-T&lt;t1&gt;;&lt;t2&gt;...</code></td>
<td class="cell85">name specifies a type or a list of types. The
output for this type and all dependent types are generated. If no '-T'
option is specified, then output for all types is generated. It is also
possible to use a wildcard 'xy.*' to generate a complete module
inclusive all subdirectories. The use of '-T*' is equivalent to no '-T'
option. Example: 'com.sun.star.uno.XInterface'
or 'com.sun.star.uno.*' are valid types.
</td>
</tr>
<tr>
<td class="cell15"><code>-B&lt;name&gt;</code></td>
<td class="cell85">name specifies the base node. All types are
searched under this node. Default is the root '/' of the registry
files.
<br/>
<i>This option has been removed in LibreOffice 4.1.</i>
</td>
</tr>
<tr>
<td class="cell15"><code>-nD</code></td>
<td class="cell85">no dependent types are generated.</td>
</tr>
<tr>
<td class="cell15"><code>-G</code></td>
<td class="cell85">generate only target files which do not
exist.</td>
</tr>
<tr>
<td class="cell15"><code>-Gc</code></td>
<td class="cell85">generate only target files whose content will
be changed.</td>
</tr>
<tr>
<td class="cell15"><code>-X&lt;name&gt;</code></td>
<td class="cell85">extra types, which will not be taken into account
for generation.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="climaker"/>climaker</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The 'climaker' (windows only) generates the appropriate CLI assemblies file for each idl
type. The climaker works on a typelibrary which is generated by the
UNOIDL compiler (<a href="#unoidl-write" title="link to the unoidl-write tool description">
unoidl-write</a>). It generates the output for all specified types and for all
types the specified types depend on.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>climaker &lt;switches&gt; [registry-file-1 registry-file-2 ...]</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-O, --out &lt;output_file&gt;</code></td>
<td class="cell85">output assembly file;<br/>
defaults to cli_unotypes.dll if more than one registry-file is given, else &lt;registry-file&gt;.dll</td>
</tr>
<tr>
<td class="cell15"><code>-T, --types &lt;type1[;type2;...]&gt;</code></td>
<td class="cell85">types to be generated (if none is given,
then all types of given registries are emitted</td>
</tr>
<tr>
<td class="cell15"><code>-X, --extra &lt;rdb-file&gt;></code></td>
<td class="cell85">additional rdb to saturate referenced types in
given registry file(s); these types will not be
emitted into the output assembly file</td>
</tr>
<tr>
<td class="cell15"><code>-r, --reference &lt;assembly-file&gt;</code></td>
<td class="cell85">reference metadata from assembly file</td>
</tr>
<tr>
<td class="cell15"><code>-k, --keyfile</code></td>
<td class="cell85">keyfile needed for strong name</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-version &lt;version&gt;</code></td>
<td class="cell85">sets assembly version</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-description &lt;text&gt;</code></td>
<td class="cell85">sets assembly description text</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-product &lt;text&gt;</code></td>
<td class="cell85">sets assembly product name</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-company &lt;text&gt;</code></td>
<td class="cell85">sets assembly company</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-copyright &lt;text&gt;</code></td>
<td class="cell85">sets assembly copyright</td>
</tr>
<tr>
<td class="cell15"><code>--assembly-trademark &lt;text&gt;</code></td>
<td class="cell85">sets assembly trademark</td>
</tr>
<tr>
<td class="cell15"><code>-v, --verbose</code></td>
<td class="cell85">verbose output to stdout</td>
</tr>
<tr>
<td class="cell15"><code>-h, --help</code></td>
<td class="cell85">this message</td>
</tr>
</table>
<p><b>Example:</b> <code>climaker --out cli_mytypes.dll --reference cli_uretypes.dll --extra types.rdb mytypes.rdb</code></p>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="uno-skeletonmaker"/>uno-skeletonmaker</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The 'uno-skeletonmaker' is a tool to simplify the UNO component development. It has different modes, from simply dumping code definitions for different languages on stdout up to generating complete code skeletons. The generation of code skeletons support common component skeletons as well as specialized skeletons for special service provider interfaces.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>
uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) dump [&lt;options>] -t &lt;type&gt; ...<br/>
uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) component [&lt;options&gt;] -n &lt;name&gt; -t &lt;type&gt; ...<br/>
uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) calc-add-in [&lt;options&gt;] -n &lt;name&gt; -t &lt;add-in_service&gt;<br/>
uno-skeletonmaker (-env:INIFILENAME=&lt;url&gt;) add-on [&lt;options&gt;] -n &lt;name&gt; -p &lt;protocol_name:command,...&gt;
uno-skeletonmaker -V, --version<br/>
uno-skeletonmaker -h, --help<br/>
</code></b>
</blockquote>
<p class="head2">Sub-commands:</p>
<table class="table4">
<tr>
<td class="cell15"><code>dump</code></td>
<td class="cell85">dump declarations on stdout (e.g. constructors, methods, type mapping for properties) or complete method bodies with method forwarding.</td>
</tr>
<tr>
<td class="cell15"><code>component</code></td>
<td class="cell85">generates language specific code skeleton files using the implementation name as the file and class name</td>
</tr>
<tr>
<td class="cell15"><code>calc-add-in</code></td>
<td class="cell85">generates a language specific code skeleton for a Calc Add-Ins using the implementation name as the file and class name. A service type is necessary, referencing an interface which defines the new add-in functions.</td>
</tr>
<tr>
<td class="cell15"><code>add-on</code></td>
<td class="cell85">generates a language specific code skeleton for an add-on component using the implementation name as the file and class name. The protocol name(s) and the corresponding command(s) have to be specified with the '-p' option.</td>
</tr>
</table>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-env:INIFILENAME=&lt;url&gt;</code></td>
<td class="cell85">url specifies a URL to a UNO ini|rc file of an existing UNO environment (URE, office installation).</td>
</tr>
<tr>
<td class="cell15"><code>-a, --all</code></td>
<td class="cell85">list all interface methods, not only the direct ones</td>
</tr>
<tr>
<td class="cell15"><code>--(java5|cpp)</code></td>
<td class="cell85">select the target language<br/>
--java5 generate output for Java 1.5 or later (is currently the default)<br/>
--cpp generate output for C++</td>
</tr>
<tr>
<td class="cell15"><code>-sn, --shortnames</code></td>
<td class="cell85">using namespace abbreviation 'css:': for '::com::sun::star::', only valid for sub-command 'dump' and target language 'cpp'. It is default for the sub-command 'component'.</td>
</tr>
<tr>
<td class="cell15"><code>--propertysetmixin</code></td>
<td class="cell85">the generated skeleton implements the cppu::PropertySetMixin helper if a referenced new style service specifies an interface which provides attributes (directly or inherited).</td>
</tr>
<tr>
<td class="cell15"><code>-lh, --licenseheader</code></td>
<td class="cell85">generates a default LibreOffice MPLv2 license header at the beginning of a component source file. This option is taken into account in 'component' mode only and if -o is unequal 'stdout'.</td>
</tr>
<tr>
<td class="cell15"><code>-bc,<br>--backward-compatible</code></td>
<td class="cell85">specifies that the generated calc add-in is backward compatible to older office versions and implement the former required add-in interfaces where the implementation is mapped on the new add-in configuration. In this case the config schema needs to be bundled with the extension add-in as well. Default is a minimal add-in component skeleton based on the add-in configuration coming with the office since OO.org 2.0.4.</td>
</tr>
<tr>
<td class="cell15"><code>-o &lt;path&gt;</code></td>
<td class="cell85">path specifies an existing directory where the output files are generated to, only valid for sub-command 'component'. If path=stdout the generated code is generated on standard out instead of a file.</td>
</tr>
<tr>
<td class="cell15"><code>-l &lt;file&gt;</code></td>
<td class="cell85">specifies a binary type library (can be used more than once). The type library is integrated as an additional type provider in the bootstrapped type system.</td>
</tr>
<tr>
<td class="cell15"><code>-n &lt;name&gt;</code></td>
<td class="cell85">specifies an implementation name for the component (used as classname, filename and package|namespace name). In 'dump' mode it is used as classname (e.g. &quot;MyBase::&quot;, C++ only) to generate method bodies not inline.</td>
</tr>
<tr>
<td class="cell15"><code>-d &lt;name&gt;</code></td>
<td class="cell85">specifies a base classname or a delegator. In 'dump' mode it is used as a delegator to forward methods. It can be used as '&lt;name&gt;::' for base forwarding, or '&lt;name&gt;-&gt;|.' for composition. Using &quot;_&quot; means that a default bodies with default return values are dumped.</td>
</tr>
<tr>
<td class="cell15"><code>-t &lt;name&gt;</code></td>
<td class="cell85">specifies a UNOIDL type name, e.g. com.sun.star.text.XText (can be used more than once).</td>
</tr>
<tr>
<td class="cell15"><code>-p &lt;protocol:cmd(s)&gt;</code></td>
<td class="cell85">specifies an add-on protocol name and the corresponding command names, where the commands are a ',' separated list of unique commands. This option is only valid for add-ons.</td>
</tr>
<tr>
<td class="cell15"><code>-V, --version</code></td>
<td class="cell85">print version number and exit.</td>
</tr>
<tr>
<td class="cell15"><code>-h, --help</code></td>
<td class="cell85">print this help and exit.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="regview"/>regview</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>'regview' is a tool to show the contents of a legacy registry file. The tool
dumps the hierarchical structure and the values of the nodes in a human
readable manner to stdout.</p>
<p class="head2">Usage:</p>
<blockquote>
<b><code>regview &lt;registryfile&gt; [&lt;keyName&gt;]</code></b>
</blockquote>
<p class="head2">Options:</p>
<table class="table4">
<tr>
<td class="cell15"><code>-br&lt;registryfile&gt;</code></td>
<td class="cell85">the name of the registry whose contents should
be viewed.</td>
</tr>
<tr>
<td class="cell15"><code>&lt;keyName&gt;</code></td>
<td class="cell85">the name of a registry key. The name must be
fully qualified; for example, '/' means the root key and
'/UCR/com/sun/star/uno/XInterface' shows the type specification of the
XInterface type. If no key is specified, the tool dumps the whole
content of the registry file.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
<tr>
<td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
</tr>
<tr>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
<td>
<table class="table2">
<tr>
<td colspan="2" class="head1"><a name="autodoc"/>autodoc</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
<a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
</td>
</tr>
<tr>
<td colspan="3">
<p>The legacy 'autodoc' tool was used for creating javadoc-like
documentation from C++ and UNO IDL source code in previous versions
of the SDK.</p>
<p>Because this tool was buggy and unmaintained it has been removed
from the SDK. Users are advised to use
<a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> instead,
which supports UNO IDL since April 2013.</p>
</td>
</tr>
</table>
</td>
<td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
</tr>
</table>
</div>
<div id="Footer">
<div id="FooterText">
<p>
Copyright © 2000–2024 LibreOffice contributors. All rights reserved.
<br/>
LibreOffice was created by The Document Foundation,
based on Apache OpenOffice, which is Copyright 2011,
The Apache Software Foundation.
<br/>
The Document Foundation acknowledges all community members, please find more info <a href="https://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.
</p>
<p>
&nbsp;
</p>
<p>
<a href="http://www.documentfoundation.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.documentfoundation.org/imprint" target="_blank">Impressum (Legal Info)</a>
| Copyright information: The source code of LibreOffice is licensed under the Mozilla Public License v2.0 (<a href="http://www.libreoffice.org/download/license/" target="_blank">MPLv2</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.
</p>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink