1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_util_PathSubstitution_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_util_PathSubstitution_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_util_XStringSubstitution_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/util/XStringSubstitution.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_container_XContainerListener_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/container/XContainerListener.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir 45*cdf0e10cSrcweirmodule com { module sun { module star { module util { 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir//============================================================================= 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir/** A service to support the substitution and resubstitution of path variables. 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir <p> 52*cdf0e10cSrcweir A path variable must be specified with the following synatx: "$("<variable-name>")". 53*cdf0e10cSrcweir Path variables are not case sensitive and are always provided as a UCB-complient URL's 54*cdf0e10cSrcweir (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an 55*cdf0e10cSrcweir optional remote file system.<br> 56*cdf0e10cSrcweir A user defined list of path variables is supported. This list is stored in the Office 57*cdf0e10cSrcweir configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the 58*cdf0e10cSrcweir schema definition file which configuration structure this file uses.<br> 59*cdf0e10cSrcweir There is also a set of variables that have pre-defined values: 60*cdf0e10cSrcweir </p> 61*cdf0e10cSrcweir <dl> 62*cdf0e10cSrcweir <dt>$(inst)</dt> 63*cdf0e10cSrcweir <dd>Installation path of the Office Basis layer.</dd> 64*cdf0e10cSrcweir <dt>$(prog)</dt> 65*cdf0e10cSrcweir <dd>Program path of the Office Basis layer.</dd> 66*cdf0e10cSrcweir <dt>$(brandbaseurl)</dt> 67*cdf0e10cSrcweir <dd>Installation path of the the Office Brand layer.</dd> 68*cdf0e10cSrcweir <dt>$(user)</dt> 69*cdf0e10cSrcweir <dd>The user installation directory.</dd> 70*cdf0e10cSrcweir <dt>$(work)</dt> 71*cdf0e10cSrcweir <dd>The work directory of the user. Under Windows this would be the 72*cdf0e10cSrcweir "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd> 73*cdf0e10cSrcweir <dt>$(home)</dt> 74*cdf0e10cSrcweir <dd>The home directory of the user. Under Unix this would be the home- 75*cdf0e10cSrcweir directory. Under Windows this would be the "Documents and Settings\<username>" 76*cdf0e10cSrcweir subdirectory.</dd> 77*cdf0e10cSrcweir <dt>$(temp)</dt> 78*cdf0e10cSrcweir <dd>The current temporary directory.</dd> 79*cdf0e10cSrcweir <dt>$(path)</dt> 80*cdf0e10cSrcweir <dd>The value of PATH environment variable.</dd> 81*cdf0e10cSrcweir <dt>$(lang)</dt> 82*cdf0e10cSrcweir <dd>The country code used by the Office, like 01=english, 49=german.</dd> 83*cdf0e10cSrcweir <dt>$(langid)</dt> 84*cdf0e10cSrcweir <dd>The language code used by the Office, like 0x0009=english, 0x0409=english us.</dd> 85*cdf0e10cSrcweir <dt>$(vlang)</dt> 86*cdf0e10cSrcweir <dd>The language used by the Office as a string. Like "german" for a german Office.</dd> 87*cdf0e10cSrcweir </dl> 88*cdf0e10cSrcweir <p> 89*cdf0e10cSrcweir Attention: Most predefined variables describe an absolute path. 90*cdf0e10cSrcweir The only exceptions are: $(lang), $(langid) and $(vlang). 91*cdf0e10cSrcweir Therefore the service implementation should only substitute variables which 92*cdf0e10cSrcweir are located at the start of a provided path string or are part of a multi-path. 93*cdf0e10cSrcweir This special service is not designed to be a text substiution but shall 94*cdf0e10cSrcweir provide (a) valid substituted path(s). 95*cdf0e10cSrcweir </p> 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir @since OOo 1.1.2 98*cdf0e10cSrcweir*/ 99*cdf0e10cSrcweir 100*cdf0e10cSrcweirpublished service PathSubstitution 101*cdf0e10cSrcweir{ 102*cdf0e10cSrcweir //------------------------------------------------------------------------- 103*cdf0e10cSrcweir /** Interface to exchange path variables with defined paths and to resubstitute paths with path variables. 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir <p> 106*cdf0e10cSrcweir To resubstitute path variables the caller must provide pathes as UCB-compliant URL's. 107*cdf0e10cSrcweir </p> 108*cdf0e10cSrcweir */ 109*cdf0e10cSrcweir interface com::sun::star::util::XStringSubstitution; 110*cdf0e10cSrcweir}; 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir//============================================================================= 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir}; }; }; }; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir#endif 117