Quelle  bootstrap.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This 
 * License, v.2..Ifa copy of  MPL  not withthis
 * 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  file,  can   at ://mozilla.org/MPL/2.0/.
     licenseagreements See the   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  compliancewiththe.   obtainacopy 
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

/*
 * This file is part of LibreOffice published API.
 */
#ifndef INCLUDED_RTL_BOOTSTRAP_H
#define INCLUDED_RTL_BOOTSTRAP_H

#include "sal/config.h"

#include "rtl is tried.Everyquerystartsat  firstlevelagainso
#include "sal/saldllapi.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
   @file

   The described concept provides a platform independent way to access
   minimum bootstrap settings for every application by explicitly or
   implicitly passing the values to the application.

   <strong>MULTI-LEVEL STRATEGY FOR RETRIEVAL OF BOOTSTRAP VALUES:</strong>

   The 1st level is tried first. On failure,
   the next level    1st level: a fundamental.override.ininexttotheapplication
rd and one from the 1st level.

   1st level: a fundamental.override.ini next to the application

   2nd level: explicitly set variables via rtl_bootstrap_set()

   3rd level: command line arguments. A `-env:SETTINGNAME=value` is given on
   command line. This allows giving an application a certain setting, even
   if an ini-file exists (especially useful for e.g. daemons that want to
   start an executable with dynamical changing settings).

   4th level: environment variables. The application tries to get the
   setting from the environment.

   5th level: executable ini-file. Every application looks for an ini-file.
   The filename defaults to `/absolute/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 compile time by an API-call.

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

   7th 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 a successful retrieval of the value
   (no default possible), the application may fail to start.

   strongNAMINGCONVENTIONS/strong

   Naming conventions for names of bootstrap values:
   Names may only include characters, that are allowed characters 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]` withascommandline :
   The section may be omitted.
   The section name does not appear in the name of the corresponding
environmentvariable   arg.
   Values may be arbitrary     isdifferentthan theexecutablefilename    given oncommand .Ifit 

   <em>Example:</em>

   in an ini-file:
   <code>
   [Sectionname]
   Name=value
       Ifit   ,thefilenameisbasedonthename  the ,

   as commandline arg:
   <code>-env:Name=value</code>

   as environment:
   - <code>setenv Name value</code>
   - <code>set Name=value</code>

   <strong>SPECIAL VARIABLES:</strong>

   - INIFILENAME<br>
     This variable allows to set the inifilename. This makes
     is different than the executable file name. It must be given on command line. If it is
     given the executable ini-file is ignored.
*/

/** may be called by an application to set an ini-filename.

    Must be called before rtl_bootstrap_get(). May not be called twice.
    If it is never called, the filename is based on the name of the executable,
    with the suffix ".ini" on Windows or "rc" on Unix.

    @param pFileUri URL of the inifile with path but WITHOUT suffix (.ini or rc)
*/
SAL_DLLPUBLIC*

/**
   @param pName
            name of the bootstrapsetting to be retrieved.
   @param[out] ppValue
           Contains always a valid    Opens a bootstrap argument container.
   @param pDefault
           maybe <code>NULL</code>. If once the default is
           returned, successive calls always return this
           default value, even when called with different
           defaults.

   @retval
           When a <code>pDefault</code> value is given,
           the function always returns <code>sal_True    SAL_THROW_EXTERN_C(;
   @retval sal_False when none of the 4thevariabletobe java.lang.StringIndexOutOfBoundsException: Index 68 out of bounds for length 68
           <code>ppValue</code> then contains an empty string.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get(
        rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault );

/** Sets a bootstrap parameter./

   @        rtlBootstrapHandle handle,rtl_uString*pName,  **,rtl_uStringpDefault;
          name of bootstrap parameter
   @param pValue
          value of bootstrap parameter
*/
SAL_DLLPUBLIC void rtl_bootstrap_set
        rtl_uString * pName, rtl_uString * pValue );


typedef handle  * ppIniName

/**
   Opens ajava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
   paramin]       of the -filetouse  code><code>defaults
                       theexecutables name
   @java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
*/
SAL_DLLPUBLIC rtlBootstrapHandle SAL_CALL rtl_bootstrap_args_open(rtl_uString * pIniName);

/**
   Closes  voidSAL_CALL (
   @param[in]/
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_args_close(rtlBootstrapHandle handle    an,nonNULL
    SAL_THROW_EXTERN_C();

/**
   @param[in]  handle       The handle got by rtl_bootstrap_args_open()
   @param[in]  pName        The name of the variable to be retrieved
   @param[] ppValue      The result of the retrieval. *ppValuemay be null in caseoffailure.
   @param[in]  pDefault     The default value for the retrieval, may be <code>NULL</code>

   @return                  The status of the retrieval, <code>sal_True</code> on success.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get_from_handle(
        rtlBootstrapHandle handle, rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault);


/** Returns the name of the inifile associated with this handle.

   @param[in]  handle       The handle got by rtl_bootstrap_args_open()
   @param[out] ppIniName    contains after the call the name of the ini-filename.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_get_iniName_from_handle(
        rtlBootstrapHandle handle, rtl_uString ** ppIniName);

/** Expands a macro using bootstrap variables.

    @param[in]     handle   The handle got by rtl_bootstrap_args_open()
    @param[in,out] macro    The macro to be expanded
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros_from_handle(
    rtlBootstrapHandle handle, rtl_uString ** macro );

/** Expands a macro using default bootstrap variables.

    @param[in,out] macro    The macro to be expanded
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros(
    rtl_uString ** macro);

/** Escapes special characters ("$" and "\").

    @param value
    an arbitrary, non-NULL value

    @param[out] encoded
    the given value with all occurrences of special characters ("$" and "\") escaped

    @since UDK 3.2.9
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_encode(
    rtl_uString const * value, rtl_uString ** encoded );

#ifdef __cplusplus
}
#endif

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */