/***************************************************************************
 *   Copyright (C) 2008 by Dominik Seichter, Craig Ringer                  *
 *   domseichter@web.de                                                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License as       *
 *   published by the Free Software Foundation; either version 2 of the    *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 *                                                                         *
 *   In addition, as a special exception, the copyright holders give       *
 *   permission to link the code of portions of this program with the      *
 *   OpenSSL library under certain conditions as described in each         *
 *   individual source file, and distribute linked combinations            *
 *   including the two.                                                    *
 *   You must obey the GNU General Public License in all respects          *
 *   for all of the code used other than OpenSSL.  If you modify           *
 *   file(s) with this exception, you may extend this exception to your    *
 *   version of the file(s), but you are not obligated to do so.  If you   *
 *   do not wish to do so, delete this exception statement from your       *
 *   version.  If you delete this exception statement from all source      *
 *   files in the program, then also delete it here.                       *
 ***************************************************************************/

#ifndef PDFMUTEXIMPL_NOOP_H
#define PDFMUTEXIMPL_NOOP_H

#include "../PdfDefines.h"
#include "../PdfDefinesPrivate.h"

#if defined(PODOFO_MULTI_THREAD)
#error "Multi-thread build, a real PdfMutex implementation should be used instead"
#endif

namespace PoDoFo {
namespace Util {

/**
 * A platform independent non-reentrant mutex, no-op implementation.
 * This version is used if PoDoFo is built without threading support.
 *  
 * PdfMutex is *NOT* part of PoDoFo's public API.
 */
class PdfMutexImpl {
  public:
    /** Construct a new mutex
     */
    inline PdfMutexImpl() { }

    inline ~PdfMutexImpl() { }

    /**
     * Lock the mutex
     */
    inline void Lock() { }

    /**
     * Try locking the mutex. 
     *
     * \returns true if the mutex was locked
     * \returns false if the mutex is already locked
     *                by some other thread
     */
    inline bool TryLock() { return true; }

    /**
     * Unlock the mutex
     */
    inline void UnLock() { }
};

}; // Util
}; // PoDoFo

#endif // PDFMUTEXIMPL_NOOP_H
