#100075# macro expander

1 files changed, 111 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/util/MacroExpander.idl b/udkapi/com/sun/star/util/MacroExpander.idl
new file mode 100644
index 000000000000..deddcee12400
--- /dev/null
+++ b/udkapi/com/sun/star/util/MacroExpander.idl
@@ -0,0 +1,111 @@
+/*************************************************************************
+ *
+ *  $RCSfile: MacroExpander.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: dbo $ $Date: 2002-06-14 12:47:52 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2002 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_util_MacroExpander_idl__
+#define __com_sun_star_util_MacroExpander_idl__
+
+#ifndef __com_sun_star_util_XMacroExpander_idl__
+#include <com/sun/star/util/XMacroExpander.idl>
+#endif
+
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+
+
+//=============================================================================
+
+module com {  module sun {  module star {  module util {
+
+//=============================================================================
+
+/** This meta service supports the XMacroExpander interface for expanding
+    arbitrary macro expressions, i.e. substitude macro names.
+    The purpose of this service is to separate the use of macrofied strings,
+    e.g. urls from the use of services.
+
+    @see BootstrapMacroExpander
+    @see theMacroExpander
+*/
+service MacroExpander
+{
+    interface XMacroExpander;
+    [optional] interface com::sun::star::lang::XComponent;
+};
+
+/** A service that has to deal with macrofied strings will preprocess those
+    strings using the macro expander singleton.
+    The macro expander singleton is deployed with the application.
+
+    This feature is currently used macrofying loader urls with macros defined
+    in uno.ini/unorc bootstrap files.  The component loader uses the macro
+    expander singleton to expand those macros.  This is a flexible way
+    preprocessing loader urls.
+
+    @see MacroExpander
+*/
+singleton theMacroExpander
+{
+    service MacroExpander;
+};
+
+}; }; }; };
+
+#endif