/*************************************************************************
 *
 * 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
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_util_PathSubstitution_idl__
#define __com_sun_star_util_PathSubstitution_idl__

#ifndef __com_sun_star_util_XStringSubstitution_idl__
#include <com/sun/star/util/XStringSubstitution.idl>
#endif

#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif

#ifndef __com_sun_star_container_XContainerListener_idl__
#include <com/sun/star/container/XContainerListener.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module  util {

//=============================================================================

/** A service to support the substitution and resubstitution of path variables.

        <p>
        A path variable must be specified with the following syntax: "$("&lt;variable-name&gt;")".
        Path variables are not case sensitive and are always provided as a UCB-compliant URLs
        (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an
        optional remote file system.<br>
        A user defined list of path variables is supported. This list is stored in the Office
        configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the
        schema definition file which configuration structure this file uses.<br>
        There is also a set of variables that have pre-defined values:
        </p>
        <dl>
        <dt>$(inst)</dt>
        <dd>Installation path of the Office Basis layer.</dd>
        <dt>$(prog)</dt>
        <dd>Program path of the Office Basis layer.</dd>
    <dt>$(brandbaseurl)</dt>
    <dd>Installation path of the the Office Brand layer.</dd>
        <dt>$(user)</dt>
        <dd>The user installation directory.</dd>
        <dt>$(work)</dt>
        <dd>The work directory of the user. Under Windows this would be the
        "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd>
    <dt>$(home)</dt>
        <dd>The home directory of the user. Under Unix this would be the home-
            directory. Under Windows this would be the "Documents and Settings\<username>"
         subdirectory.</dd>
    <dt>$(temp)</dt>
        <dd>The current temporary directory.</dd>
    <dt>$(path)</dt>
        <dd>The value of PATH environment variable.</dd>
    <dt>$(lang)</dt>
        <dd>The country code used by the Office, like 01=English, 49=German.</dd>
        <dt>$(langid)</dt>
        <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd>
    <dt>$(vlang)</dt>
        <dd>The language used by the Office as a string. Like "German" for a German Office.</dd>
        </dl>
        <p>
        Attention: Most predefined variables describe an absolute path.
        The only exceptions are: $(lang), $(langid) and $(vlang). 
        Therefore the service implementation should only substitute variables which
        are located at the start of a provided path string or are part of a multi-path. 
        This special service is not designed to be a text substiution but shall
        provide (a) valid substituted path(s).
        </p>

    @since OOo 1.1.2
*/

published service PathSubstitution
{
        //-------------------------------------------------------------------------
        /** Interface to exchange path variables with defined paths and to resubstitute paths with path variables.

                <p>
                To resubstitute path variables the caller must provide paths as UCB-compliant URLs.
                </p>
        */
        interface com::sun::star::util::XStringSubstitution;
};

//=============================================================================

}; }; }; };

#endif
