configmgr/source/treemgr/templateimpl.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: templateimpl.hxx,v $
  10  * $Revision: 1.17 $
  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 CONFIGMGR_TEMPLATEIMPL_HXX_
  32 #define CONFIGMGR_TEMPLATEIMPL_HXX_
  33
  34 #include "template.hxx"
  35 #include "configpath.hxx"
  36 #include "requestoptions.hxx"
  37 #include <rtl/ustrbuf.hxx>
  38 #include <rtl/ref.hxx>
  39 #include <salhelper/simplereferenceobject.hxx>
  40 #include "utility.hxx"
  41
  42 #ifndef INCLUDED_MAP
  43 #include <map>
  44 #define INCLUDED_MAP
  45 #endif
  46
  47 namespace configmgr
  48 {
  49 //-----------------------------------------------------------------------------
  50     namespace data { class TreeSegment; }
  51 //-----------------------------------------------------------------------------
  52
  53     namespace configuration
  54     {
  55 //-----------------------------------------------------------------------------
  56
  57
  58         //-----------------------------------------------------------------------------
  59         // class TemplateName
  60         //-----------------------------------------------------------------------------
  61         struct TemplateName
  62         {
  63             //-----------------------------------------------------------------
  64             rtl::OUString aName, aModule;
  65
  66             //-----------------------------------------------------------------
  67             TemplateName()
  68             : aName()
  69             , aModule()
  70             {}
  71
  72             TemplateName(rtl::OUString const& aName_)
  73             : aName(aName_)
  74             , aModule()
  75             {}
  76
  77             TemplateName(rtl::OUString const& aName_, rtl::OUString const& aModule_)
  78             : aName(aName_)
  79             , aModule(aModule_)
  80             {}
  81
  82             //-----------------------------------------------------------------
  83
  84             /// compose the path where the template is located
  85             rtl::OUString makePathString() const
  86             {
  87                 rtl::OUStringBuffer aBuffer;
  88
  89                 if (aModule.getLength() != 0)
  90                     aBuffer.append( this->aModule ).append(sal_Unicode('/'));
  91
  92                 aBuffer.append( this->aName );
  93
  94                 return aBuffer.makeStringAndClear();
  95             }
  96             //-----------------------------------------------------------------
  97             bool isEmpty() const
  98             {
  99                 return aName.getLength() == 0;
 100             }
 101
 102             bool isSimpleTypeName() const;
 103
 104             com::sun::star::uno::Type resolveToSimpleType() const;
 105             //-----------------------------------------------------------------
 106
 107             bool operator<(TemplateName const& aOther) const
 108             {
 109                 return (aModule == aOther.aModule) ? (aName < aOther.aName) : (aModule < aOther.aModule);
 110             }
 111
 112             //-----------------------------------------------------------------
 113             static com::sun::star::uno::Type resolveSimpleTypeName(rtl::OUString const& aName);
 114             //-----------------------------------------------------------------
 115 #if OSL_DEBUG_LEVEL > 0
 116             static rtl::OUString makeNativeTypeModuleName();
 117             //-----------------------------------------------------------------
 118             static rtl::OUString makeLocalizedTypeModuleName();
 119 #endif
 120             //-----------------------------------------------------------------
 121         };
 122     //-------------------------------------------------------------------------
 123
 124         //---------------------------------------------------------------------
 125         // class TemplateImplHelper
 126         //---------------------------------------------------------------------
 127
 128         class TemplateImplHelper
 129         {
 130         public:
 131             //-----------------------------------------------------------------
 132
 133             static com::sun::star::uno::Type getNoTypeAvailable()
 134             {
 135                 return getVoidCppuType();
 136             }
 137             //-----------------------------------------------------------------
 138
 139             static void assignActualType (Template& aTemplate,com::sun::star::uno::Type const& aType);
 140             //-----------------------------------------------------------------
 141
 142             static rtl::Reference<Template> makeElementTemplateWithType(TemplateName const& aNames, TemplateProvider const& _aProvider, sharable::SetNode * set);
 143             //-----------------------------------------------------------------
 144
 145             static rtl::Reference<Template> createNew (TemplateName const& aNames,com::sun::star::uno::Type const& aType);
 146             //-----------------------------------------------------------------
 147         };
 148     //-------------------------------------------------------------------------
 149
 150         typedef std::map< TemplateName, rtl::Reference<Template> > TemplateRepository;
 151     //-------------------------------------------------------------------------
 152
 153         //---------------------------------------------------------------------
 154         // class TemplateProvider_Impl
 155         //---------------------------------------------------------------------
 156
 157         struct TemplateProvider_Impl : salhelper::SimpleReferenceObject
 158         {
 159             TemplateProvider_Impl(rtl::Reference< TreeManager > const & xProvider, RequestOptions const& aOptions);
 160
 161             rtl::Reference< data::TreeSegment > instantiate(rtl::Reference<Template> const& aTemplate);
 162
 163             rtl::Reference<Template> makeElementTemplateWithType(TemplateName const& _aNames, sharable::SetNode * set);
 164         private:
 165             rtl::Reference< TreeManager >      m_xProvider;
 166             RequestOptions          m_aOptions;
 167
 168             TemplateRepository      m_aRepository;
 169         };
 170
 171 //-----------------------------------------------------------------------------
 172     }
 173 }
 174
 175 #endif // CONFIGMGR_TEMPLATEIMPL_HXX_