summaryrefslogtreecommitdiff
path: root/include/comphelper/extract.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'include/comphelper/extract.hxx')
-rw-r--r--include/comphelper/extract.hxx158
1 files changed, 158 insertions, 0 deletions
diff --git a/include/comphelper/extract.hxx b/include/comphelper/extract.hxx
new file mode 100644
index 000000000000..30cbaaefc6c9
--- /dev/null
+++ b/include/comphelper/extract.hxx
@@ -0,0 +1,158 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef _COMPHELPER_EXTRACT_HXX_
+#define _COMPHELPER_EXTRACT_HXX_
+
+#include <com/sun/star/lang/IllegalArgumentException.hpp>
+#include <com/sun/star/uno/XInterface.hpp>
+#include <com/sun/star/uno/TypeClass.hpp>
+#include <com/sun/star/uno/Type.hxx>
+#include <com/sun/star/uno/Any.hxx>
+#include "cppu/unotype.hxx"
+
+namespace cppu
+{
+
+/**
+ * Sets enum from int32 value. This function does NOT check for valid enum values!
+ *<BR>
+ * @param nEnum int32 enum value
+ * @param rType enum type
+ * @return enum or emoty any.
+ */
+inline ::com::sun::star::uno::Any SAL_CALL int2enum(
+ sal_Int32 nEnum, const ::com::sun::star::uno::Type & rType )
+{
+ if (rType.getTypeClass() == ::com::sun::star::uno::TypeClass_ENUM)
+ {
+ int nVal = nEnum;
+ return ::com::sun::star::uno::Any( &nVal, rType );
+ }
+ return ::com::sun::star::uno::Any();
+}
+
+/**
+ * Sets int32 from enum or int in any.
+ *<BR>
+ * @param rnEnum [out] int32 enum value
+ * @param rAny enum or int
+ * @param sal_True if enum or int value was set else sal_False.
+ */
+inline sal_Bool SAL_CALL enum2int( sal_Int32 & rnEnum, const ::com::sun::star::uno::Any & rAny )
+{
+ if (rAny.getValueTypeClass() == ::com::sun::star::uno::TypeClass_ENUM)
+ {
+ rnEnum = * reinterpret_cast< const int * >( rAny.getValue() );
+ return sal_True;
+ }
+
+ return rAny >>= rnEnum;
+}
+
+/**
+ * Sets int32 from enum or int in any with additional typecheck
+ * <BR>
+ * @param rAny enum or int
+ * @param eRet the enum value as int. If there is not enum of the given type or
+ * a ::com::sun::star::lang::IllegalArgumentException is thrown
+ */
+template< typename E >
+inline void SAL_CALL any2enum( E & eRet, const ::com::sun::star::uno::Any & rAny )
+ throw( ::com::sun::star::lang::IllegalArgumentException )
+{
+ // check for type save enum
+ if (! (rAny >>= eRet))
+ {
+ // if not enum, maybe integer?
+ sal_Int32 nValue = 0;
+ if (! (rAny >>= nValue))
+ throw ::com::sun::star::lang::IllegalArgumentException();
+
+ eRet = (E)nValue;
+ }
+}
+
+/**
+ * Template function to create an uno::Any from an enum
+ *
+ * @DEPRECATED : use makeAny< E >()
+ *
+ */
+template< typename E >
+inline ::com::sun::star::uno::Any SAL_CALL enum2any( E eEnum )
+{
+ return ::com::sun::star::uno::Any( &eEnum, ::cppu::UnoType< E >::get() );
+}
+
+/**
+ * Extracts interface from an any. If given any does not hold the demanded interface,
+ * it will be queried for it.
+ * If no interface is available, the out ref will be cleared.
+ *<BR>
+ * @param rxOut [out] demanded interface
+ * @param rAny interface
+ * @return sal_True if any reference (including the null ref) was retrieved from any else sal_False.
+ */
+template< class T >
+inline sal_Bool SAL_CALL extractInterface(
+ ::com::sun::star::uno::Reference< T > & rxOut,
+ const ::com::sun::star::uno::Any & rAny )
+{
+ rxOut.clear();
+ return (rAny >>= rxOut);
+}
+
+/**
+ * extracts a boolean either as a sal_Bool or an integer from
+ * an any. If there is no sal_Bool or integer inside the any
+ * a ::com::sun::star::lang::IllegalArgumentException is thrown
+ *
+ */
+inline sal_Bool SAL_CALL any2bool( const ::com::sun::star::uno::Any & rAny )
+ throw( ::com::sun::star::lang::IllegalArgumentException )
+{
+ if (rAny.getValueTypeClass() == ::com::sun::star::uno::TypeClass_BOOLEAN)
+ {
+ return *(sal_Bool *)rAny.getValue();
+ }
+ else
+ {
+ sal_Int32 nValue = 0;
+ if (! (rAny >>= nValue))
+ throw ::com::sun::star::lang::IllegalArgumentException();
+ return nValue != 0;
+ }
+}
+
+/**
+ * Puts a boolean in an any.
+ *
+ * @DEPRECATED : use makeAny< sal_Bool >()
+ *
+ */
+inline ::com::sun::star::uno::Any SAL_CALL bool2any( sal_Bool bBool )
+{
+ return ::com::sun::star::uno::Any( &bBool, ::getCppuBooleanType() );
+}
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */