bridges/inc/types.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 <typelib/typeclass.h>
  23 #include <typelib/typedescription.h>
  24
  25 namespace bridges::cpp_uno::shared
  26 {
  27 /**
  28  * Determines whether a type is a "simple" type (VOID, BOOLEAN, BYTE, SHORT,
  29  * UNSIGNED SHORT, LONG, UNSIGNED LONG, HYPER, UNSIGNED HYPER, FLOAT, DOUBLE,
  30  * CHAR, or an enum type).
  31  *
  32  * @param typeClass a type class
  33  * @return true if the given type is "simple"
  34  */
  35 bool isSimpleType(typelib_TypeClass typeClass);
  36
  37 /**
  38  * Determines whether a type is a "simple" type (VOID, BOOLEAN, BYTE, SHORT,
  39  * UNSIGNED SHORT, LONG, UNSIGNED LONG, HYPER, UNSIGNED HYPER, FLOAT, DOUBLE,
  40  * CHAR, or an enum type).
  41  *
  42  * @param type a non-null pointer to a type description reference
  43  * @return true if the given type is "simple"
  44  */
  45 bool isSimpleType(typelib_TypeDescriptionReference const* type);
  46
  47 /**
  48  * Determines whether a type is a "simple" type (VOID, BOOLEAN, BYTE, SHORT,
  49  * UNSIGNED SHORT, LONG, UNSIGNED LONG, HYPER, UNSIGNED HYPER, FLOAT, DOUBLE,
  50  * CHAR, or an enum type).
  51  *
  52  * @param type a non-null pointer to a type description
  53  * @return true if the given type is "simple"
  54  */
  55 bool isSimpleType(typelib_TypeDescription const* type);
  56
  57 /**
  58  * Determines whether a type relates to an interface type (is itself an
  59  * interface type, or might contain entities of interface type).
  60  *
  61  * @param type a non-null pointer to a type description
  62  * @return true if the given type relates to an interface type
  63  */
  64 bool relatesToInterfaceType(typelib_TypeDescription const* type);
  65 }
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */