include/codemaker/unotype.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CODEMAKER_UNOTYPE_HXX
  21 #define INCLUDED_CODEMAKER_UNOTYPE_HXX
  22
  23 #include <sal/types.h>
  24
  25 #include <vector>
  26
  27 namespace rtl { class OString; }
  28
  29 namespace codemaker {
  30
  31 namespace UnoType {
  32     /**
  33        An enumeration of all the sorts of relevant UNOIDL entities.
  34      */
  35     enum class Sort {
  36         Void,
  37         Boolean,
  38         Byte,
  39         Short,
  40         UnsignedShort,
  41         Long,
  42         UnsignedLong,
  43         Hyper,
  44         UnsignedHyper,
  45         Float,
  46         Double,
  47         Char,
  48         String,
  49         Type,
  50         Any,
  51         Sequence,
  52         Module,
  53         Enum,
  54         PlainStruct,
  55         PolymorphicStructTemplate,
  56         InstantiatedPolymorphicStruct,
  57         Exception,
  58         Interface,
  59         Typedef,
  60         ConstantGroup,
  61         SingleInterfaceBasedService,
  62         AccumulationBasedService,
  63         InterfaceBasedSingleton,
  64         ServiceBasedSingleton
  65     };
  66
  67     /**
  68        Decomposes a UNO type name or UNO type registry name.
  69
  70        @param type a binary UNO type name or UNO type registry name
  71
  72        @param rank if non-null, returns the rank of the denoted UNO type (which
  73        is zero for any given type that does not denote a UNO sequence type)
  74
  75        @param arguments if non-null, the type arguments are stripped from an
  76        instantiated polymorphic struct type and returned via this parameter (in
  77        the correct order); if null, type arguments are not stripped from
  78        instantiated polymorphic struct types
  79
  80        @return the base part of the given type
  81      */
  82     rtl::OString decompose(
  83         rtl::OString const & type, sal_Int32 * rank = nullptr,
  84         std::vector< rtl::OString > * arguments = nullptr);
  85 }
  86
  87 }
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */