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 #pragma once
  21
  22 #include <sal/types.h>
  23
  24 #include <vector>
  25
  26 namespace rtl { class OString; }
  27
  28 namespace codemaker::UnoType {
  29     /**
  30        An enumeration of all the sorts of relevant UNOIDL entities.
  31      */
  32     enum class Sort {
  33         Void,
  34         Boolean,
  35         Byte,
  36         Short,
  37         UnsignedShort,
  38         Long,
  39         UnsignedLong,
  40         Hyper,
  41         UnsignedHyper,
  42         Float,
  43         Double,
  44         Char,
  45         String,
  46         Type,
  47         Any,
  48         Sequence,
  49         Module,
  50         Enum,
  51         PlainStruct,
  52         PolymorphicStructTemplate,
  53         InstantiatedPolymorphicStruct,
  54         Exception,
  55         Interface,
  56         Typedef,
  57         ConstantGroup,
  58         SingleInterfaceBasedService,
  59         AccumulationBasedService,
  60         InterfaceBasedSingleton,
  61         ServiceBasedSingleton
  62     };
  63
  64     /**
  65        Decomposes a UNO type name or UNO type registry name.
  66
  67        @param type a binary UNO type name or UNO type registry name
  68
  69        @param rank if non-null, returns the rank of the denoted UNO type (which
  70        is zero for any given type that does not denote a UNO sequence type)
  71
  72        @param arguments if non-null, the type arguments are stripped from an
  73        instantiated polymorphic struct type and returned via this parameter (in
  74        the correct order); if null, type arguments are not stripped from
  75        instantiated polymorphic struct types
  76
  77        @return the base part of the given type
  78      */
  79     rtl::OString decompose(
  80         rtl::OString const & type, sal_Int32 * rank = nullptr,
  81         std::vector< rtl::OString > * arguments = nullptr);
  82
  83 }
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */