Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.6 released

OpenOffice.orgNaming UNO Components


[This document is intended to become part of the Developers Guide; once that is done and available online, this document can be removed again.]

Naming Scheme

UNO components that come in the form of a shared library (.so on Linux and Solaris, .dll on Windows, .dylib on Mac) should be named as

NAME[VERSION].uno.(so|dll|dylib)
that is a descriptive NAME, followed by an optional VERSION, followed by the characters “.uno” and the platform-specific extension (“.so”, “.dll”, “.dylib”, etc.). The optional VERSION should be of the form
VERSION  =  MAJOR [.MINOR [.MICRO]]
MAJOR  =  NUMBER
MINOR  =  NUMBER
MICRO  =  NUMBER
NUMBER  =  0  |  19 09*

How to use the VERSION scheme, if at all, to number different versions of a given component shared library (e.g., only using the MAJOR and increasing it whenever the code is changed, or using all of MAJOR, MINOR, and MICRO) is not specified here.

Examples of component shared library names are

component.uno.so
component1.uno.dll
component0.1.3.uno.dylib

Rationale: The VERSION is optional and is mainly intended to be useful to humans (e.g., when communicating to others that a certain VERSION of a component has a bug); see below for some suggestions when it might be useful to use the optional VERSION and when not. The VERSION is consistently placed before the (platform-specific) extension, never after it; on Linux and Solaris, there is a convention to add a version number after the “.so”, but that version number has different semantics from the VERSION number used here (in short, such a version number changes whenever the shared library's interface changes, but that interface of a component shared library—the few functions component_getFactory etc.—never changes).

The “.uno” is placed next to the platform-specific extension to emphasize that this is a special sort of shared library (its shared library interface consists of only the few functions component_getFactory etc., and the shared library has to be registered with UNO to be useful). As the given naming scheme is only a suggestion, there might be violations of the rule where a component shared library does not contain “.uno” in its name. Therefore, no tool should build assumptions on whether a shared library name contains “.uno” or not (e.g., when pkgchk installs a zip file component, it should not simply register with UNO all those contained shared libraries that contain “.uno” in their names, but should rather use some other mechanism like a manifest file explicitly listing all the contained shared libraries that need to be registered).

For UNO components that are not shared libraries (e.g., a Java component resulting in a jar file), it can also be useful to add “.uno” (and the optional VERSION) to the component's name (e.g., component.uno.jar, or component1.5.uno.jar), for the same reasons as for component shared libraries: to emphasize that it is a UNO component. Again, this is a suggestion, not a hard rule.

Kinds of Components

When deciding whether to add an optional VERSION to a component shared library's name, it might be useful to consider the following kinds of components:

Ways Components Can Evolve

Author: Stephan Bergmann (Last modification $Date: 2003/08/21 13:27:10 $). Copyright 2003 OpenOffice.org Foundation. All Rights Reserved.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.