cppuhelper/source/macro_expander.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: macro_expander.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CPPUHELPER_SOURCE_MACRO_EXPANDER_HXX
  32 #define CPPUHELPER_SOURCE_MACRO_EXPANDER_HXX
  33
  34 #include "sal/config.h"
  35
  36 namespace rtl { class OUString; }
  37
  38 namespace cppuhelper {
  39
  40 namespace detail {
  41
  42 /**
  43  * Helper function to expand macros based on the unorc/uno.ini.
  44  *
  45  * @internal
  46  *
  47  * @param text
  48  * Some text.
  49  *
  50  * @return
  51  * The expanded text.
  52  *
  53  * @exception com::sun::star::lang::IllegalArgumentException
  54  * If uriReference is a vnd.sun.star.expand URL reference that contains unknown
  55  * macros.
  56  */
  57 ::rtl::OUString expandMacros(rtl::OUString const & text);
  58
  59 }
  60
  61 }
  62
  63 #endif