PythonIncludes.h

/*
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */

/**
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */

#ifndef PYTHONINCLUDES_H_
#define PYTHONINCLUDES_H_

// thanks to the VTK project for this patch for Visual Studio in debug mode
#if defined(_MSC_VER) && defined(_DEBUG)
// Include these low level headers before undefing _DEBUG. Otherwise when doing
// a debug build against a release build of python the compiler will end up
// including these low level headers without DEBUG enabled, causing it to try
// and link release versions of this low level C api.
# include <basetsd.h>
# include <assert.h>
# include <ctype.h>
# include <errno.h>
# include <io.h>
# include <math.h>
# include <sal.h>
# include <stdarg.h>
# include <stddef.h>
# include <stdio.h>
# include <stdlib.h>
# include <string.h>
# include <sys/stat.h>
# include <time.h>
# include <wchar.h>
#  undef _DEBUG
#  if _MSC_VER >= 1400
#    define _CRT_NOFORCE_MANIFEST 1
#  endif
#  include <Python.h>
#  include <frameobject.h>
#  include <structmember.h>
#  include <import.h>
#  include <sip.h>
#  define _DEBUG
# else
#  include <Python.h>
#  include <frameobject.h>
#  include <structmember.h>
#  include <import.h>
#  if defined(__GNUC__) && !defined(__clang__)
#    pragma GCC diagnostic push
#    pragma GCC diagnostic ignored "-pedantic"
#  endif
#  include <sip.h>
#  if defined(__GNUC__) && !defined(__clang__)
#    pragma GCC diagnostic pop
#  endif
# endif

static const sipAPIDef *getSipAPI() {
#if defined(SIP_USE_PYCAPSULE)
  return (const sipAPIDef *)PyCapsule_Import("sip._C_API", 0);
#else
  PyObject *sip_module;
  PyObject *sip_module_dict;
  PyObject *c_api;

  /* Import the SIP module. */
  sip_module = PyImport_ImportModule("sip");

  if (sip_module == NULL)
    return NULL;

  /* Get the module's dictionary. */
  sip_module_dict = PyModule_GetDict(sip_module);

  /* Get the "_C_API" attribute. */
  c_api = PyDict_GetItemString(sip_module_dict, "_C_API");

  if (c_api == NULL)
    return NULL;

  /* Sanity check that it is the right type. */
  if (!PyCObject_Check(c_api))
    return NULL;

  /* Get the actual pointer from the object. */
  return (const sipAPIDef *)PyCObject_AsVoidPtr(c_api);
#endif
}

static const sipAPIDef *sipAPIPtr = NULL;

inline const sipAPIDef * sipAPI() {
  if (!sipAPIPtr) {
    sipAPIPtr = getSipAPI();
  }

  return sipAPIPtr;
}

#define sipMalloc                   sipAPI()->api_malloc
#define sipFree                     sipAPI()->api_free
#define sipBuildResult              sipAPI()->api_build_result
#define sipCallMethod               sipAPI()->api_call_method
#define sipParseResult              sipAPI()->api_parse_result
#define sipParseArgs                sipAPI()->api_parse_args
#define sipParseKwdArgs             sipAPI()->api_parse_kwd_args
#define sipParsePair                sipAPI()->api_parse_pair
#define sipCommonDtor               sipAPI()->api_common_dtor
#define sipConvertFromSequenceIndex sipAPI()->api_convert_from_sequence_index
#define sipConvertFromVoidPtr       sipAPI()->api_convert_from_void_ptr
#define sipConvertToVoidPtr         sipAPI()->api_convert_to_void_ptr
#define sipAddException             sipAPI()->api_add_exception
#define sipNoFunction               sipAPI()->api_no_function
#define sipNoMethod                 sipAPI()->api_no_method
#define sipAbstractMethod           sipAPI()->api_abstract_method
#define sipBadClass                 sipAPI()->api_bad_class
#define sipBadCatcherResult         sipAPI()->api_bad_catcher_result
#define sipBadCallableArg           sipAPI()->api_bad_callable_arg
#define sipBadOperatorArg           sipAPI()->api_bad_operator_arg
#define sipTrace                    sipAPI()->api_trace
#define sipTransferBack             sipAPI()->api_transfer_back
#define sipTransferTo               sipAPI()->api_transfer_to
#define sipTransferBreak            sipAPI()->api_transfer_break
#define sipSimpleWrapper_Type       sipAPI()->api_simplewrapper_type
#define sipWrapper_Type             sipAPI()->api_wrapper_type
#define sipWrapperType_Type         sipAPI()->api_wrappertype_type
#define sipVoidPtr_Type             sipAPI()->api_voidptr_type
#define sipGetPyObject              sipAPI()->api_get_pyobject
#define sipGetAddress               sipAPI()->api_get_address
#define sipGetCppPtr                sipAPI()->api_get_cpp_ptr
#define sipGetComplexCppPtr         sipAPI()->api_get_complex_cpp_ptr
#define sipIsPyMethod               sipAPI()->api_is_py_method
#define sipCallHook                 sipAPI()->api_call_hook
#define sipStartThread              sipAPI()->api_start_thread
#define sipEndThread                sipAPI()->api_end_thread
#define sipConnectRx                sipAPI()->api_connect_rx
#define sipDisconnectRx             sipAPI()->api_disconnect_rx
#define sipRaiseUnknownException    sipAPI()->api_raise_unknown_exception
#define sipRaiseTypeException       sipAPI()->api_raise_type_exception
#define sipBadLengthForSlice        sipAPI()->api_bad_length_for_slice
#define sipAddTypeInstance          sipAPI()->api_add_type_instance
#define sipFreeSipslot              sipAPI()->api_free_sipslot
#define sipSameSlot                 sipAPI()->api_same_slot
#define sipPySlotExtend             sipAPI()->api_pyslot_extend
#define sipConvertRx                sipAPI()->api_convert_rx
#define sipAddDelayedDtor           sipAPI()->api_add_delayed_dtor
#define sipCanConvertToType         sipAPI()->api_can_convert_to_type
#define sipConvertToType            sipAPI()->api_convert_to_type
#define sipForceConvertToType       sipAPI()->api_force_convert_to_type
#define sipCanConvertToEnum         sipAPI()->api_can_convert_to_enum
#define sipReleaseType              sipAPI()->api_release_type
#define sipConvertFromType          sipAPI()->api_convert_from_type
#define sipConvertFromNewType       sipAPI()->api_convert_from_new_type
#define sipConvertFromEnum          sipAPI()->api_convert_from_enum
#define sipGetState                 sipAPI()->api_get_state
#define sipLong_AsUnsignedLong      sipAPI()->api_long_as_unsigned_long
#define sipExportSymbol             sipAPI()->api_export_symbol
#define sipImportSymbol             sipAPI()->api_import_symbol
#define sipFindType                 sipAPI()->api_find_type
#define sipFindNamedEnum            sipAPI()->api_find_named_enum
#define sipBytes_AsChar             sipAPI()->api_bytes_as_char
#define sipBytes_AsString           sipAPI()->api_bytes_as_string
#define sipString_AsASCIIChar       sipAPI()->api_string_as_ascii_char
#define sipString_AsASCIIString     sipAPI()->api_string_as_ascii_string
#define sipString_AsLatin1Char      sipAPI()->api_string_as_latin1_char
#define sipString_AsLatin1String    sipAPI()->api_string_as_latin1_string
#define sipString_AsUTF8Char        sipAPI()->api_string_as_utf8_char
#define sipString_AsUTF8String      sipAPI()->api_string_as_utf8_string
#define sipUnicode_AsWChar          sipAPI()->api_unicode_as_wchar
#define sipUnicode_AsWString        sipAPI()->api_unicode_as_wstring
#define sipConvertFromConstVoidPtr  sipAPI()->api_convert_from_const_void_ptr
#define sipConvertFromVoidPtrAndSize    sipAPI()->api_convert_from_void_ptr_and_size
#define sipConvertFromConstVoidPtrAndSize   sipAPI()->api_convert_from_const_void_ptr_and_size
#define sipInvokeSlot               sipAPI()->api_invoke_slot
#define sipSaveSlot                 sipAPI()->api_save_slot
#define sipClearAnySlotReference    sipAPI()->api_clear_any_slot_reference
#define sipVisitSlot                sipAPI()->api_visit_slot
#define sipWrappedTypeName(wt)      ((wt)->type->td_cname)
#define sipDeprecated               sipAPI()->api_deprecated
#define sipKeepReference            sipAPI()->api_keep_reference
#define sipRegisterPyType           sipAPI()->api_register_py_type
#define sipTypeFromPyTypeObject     sipAPI()->api_type_from_py_type_object
#define sipTypeScope                sipAPI()->api_type_scope
#define sipResolveTypedef           sipAPI()->api_resolve_typedef
#define sipRegisterAttributeGetter  sipAPI()->api_register_attribute_getter
#define sipIsAPIEnabled             sipAPI()->api_is_api_enabled
#define sipExportModule             sipAPI()->api_export_module
#define sipInitModule               sipAPI()->api_init_module

#endif /* PYTHONINCLUDES_H_ */