/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef _RTL_BOOTSTRAP_H_ #define _RTL_BOOTSTRAP_H_ #include #ifdef __cplusplus extern "C" { #endif /** @HTML @file The described concept provides a platform independent way to access minimum bootstrap settings for every application by excplitly or implicitly passing the values to the application.

MULTI-LEVEL STRATEGY FOR RETRIEVAL OF BOOTSTRAP VALUES :

The 1st level is tried first. On failure, the next level is tried. Every query starts at the first level again, so that one setting may be taken from the 3rd and one from the 1st level.

1st level: explicitly set variables via rtl_bootstrap_set() 2nd level: command line arguments. A "-env:SETTINGNAME=value" is given on command line. This allows to give an application a certain setting, even if an ini-file exists (espicially useful for e.g. daemons that want to start an executable with dynamical changing settings).

3rd level: environment variables. The application tries to get the setting from the environment.

4th level: executable ini-file. Every application looks for an ini-file. The filename defaults to /absoulte/path/to/executable[rc|.ini] (without .bin or .exe suffix). The ini-filename can be set by the special command line parameter '-env:INIFILENAME=/absolute/path/to/inifile' at runtime or it may be set at compiletime by an API-call.

5th level: URE_BOOTSTRAP ini-file. If the bootstrap variable URE_BOOTSTRAP expands to the URL of an ini-file, that ini-file is searched.

6th level: default. An application can have some default settings decided at compile time, which allow the application to run even with no deployment settings.

If neither of the above levels leads to an successful retrieval of the value (no default possible), the application may fail to start.

NAMING CONVENTIONS

Naming conventions for names of bootstrap values : Names may only include characters, that are allowed charcters for environment variables. This excludes '.', ' ', ';', ':' and any non-ascii character. Names are case insensitive.

An ini-file is only allowed to have one section, which must be named '[Bootstrap]'. The section may be omitted. The section name does not appear in the name of the corresponding environment variable or commandline arg. Values maybe arbitrary unicode strings, they must be encoded in UTF8.

Example:

in an ini-file: [Sectionname] Name=value

as commandline arg: -env:Name=value

as environment setenv Name value set Name=value

SPECIAL VARIABLES: