include/osl/interlck.h

   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_OSL_INTERLCK_H
  21 #define INCLUDED_OSL_INTERLCK_H
  22
  23 #include <sal/config.h>
  24
  25 #include <sal/saldllapi.h>
  26 #include <sal/types.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 typedef sal_Int32 oslInterlockedCount;
  33
  34 /** Increments the count variable addressed by pCount.
  35     @param pCount Address of count variable
  36     @return The adjusted value of the count variable.
  37 */
  38 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_incrementInterlockedCount(oslInterlockedCount* pCount);
  39
  40 /** Decrement the count variable addressed by pCount.
  41     @param pCount Address of count variable
  42     @return The adjusted value of the count variable.
  43 */
  44 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_decrementInterlockedCount(oslInterlockedCount* pCount);
  45
  46
  47 /// @cond INTERNAL
  48
  49 /** Increments the count variable addressed by p.
  50
  51     @attention This functionality should only be used internally within
  52     LibreOffice.
  53
  54     @param p Address of count variable
  55     @return The adjusted value of the count variable.
  56
  57     @since LibreOffice 4.0
  58 */
  59 #if HAVE_GCC_BUILTIN_ATOMIC
  60 #    define osl_atomic_increment(p)  __sync_add_and_fetch((p), 1)
  61 #else
  62 #    define osl_atomic_increment(p) osl_incrementInterlockedCount((p))
  63 #endif
  64
  65
  66 /** Decrement the count variable addressed by p.
  67
  68     @attention This functionality should only be used internally within
  69     LibreOffice.
  70
  71     @param p Address of count variable
  72     @return The adjusted value of the count variable.
  73
  74     @since LibreOffice 4.0
  75 */
  76 #if HAVE_GCC_BUILTIN_ATOMIC
  77 #    define osl_atomic_decrement(p) __sync_sub_and_fetch((p), 1)
  78 #else
  79 #    define osl_atomic_decrement(p) osl_decrementInterlockedCount((p))
  80 #endif
  81
  82 /// @endcond
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88
  89 #endif // INCLUDED_OSL_INTERLCK_H
  90
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */