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