common.h

Go to the documentation of this file.

// Copyright 2015-2024 Trimble Inc. All rights reserved.
// This file is intended for public distribution.

#ifndef SKETCHUP_COMMON_H_
#define SKETCHUP_COMMON_H_

enum SUResult {
  SU_ERROR_NONE = 0,  

  SU_ERROR_NULL_POINTER_INPUT,  

  SU_ERROR_INVALID_INPUT,  


  SU_ERROR_NULL_POINTER_OUTPUT,  

  SU_ERROR_INVALID_OUTPUT,  


  SU_ERROR_OVERWRITE_VALID,  



  SU_ERROR_GENERIC,  

  SU_ERROR_SERIALIZATION,  


  SU_ERROR_OUT_OF_RANGE,  


  SU_ERROR_NO_DATA,  



  SU_ERROR_INSUFFICIENT_SIZE,  


  SU_ERROR_UNKNOWN_EXCEPTION,  

  SU_ERROR_MODEL_INVALID,  

  SU_ERROR_MODEL_VERSION,  


  SU_ERROR_LAYER_LOCKED,  

  SU_ERROR_DUPLICATE,        

  SU_ERROR_PARTIAL_SUCCESS,  



  SU_ERROR_UNSUPPORTED,  

  SU_ERROR_INVALID_ARGUMENT,  

  SU_ERROR_ENTITY_LOCKED,  

  SU_ERROR_INVALID_OPERATION,  
};

// Define a platform-independent UTF16 type.
#if defined(__APPLE__) || defined(__LINUX__)
  #ifndef FOUNDATION_IMPORT
typedef unsigned short unichar;
  #endif  // FOUNDATION_IMPORT
#else     // WIN32
  #include <wtypes.h>
typedef wchar_t unichar;  
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS

  #define SU_EXPORT
  #if defined WIN32 && !defined GSLAPI_NO_EXPORTS
    #undef SU_EXPORT
    #ifdef GSLAPI_API_EXPORTS
      #define SU_EXPORT __declspec(dllexport)
    #else
      #define SU_EXPORT __declspec(dllimport)
    #endif  // GSLAPI_API_EXPORTS
  #endif    // WINDOWS

  #if defined __APPLE__ && !defined GSLAPI_NO_EXPORTS
    #undef SU_EXPORT
    #define SU_EXPORT __attribute__((visibility("default")))
  #endif  // #if defined __APPLE__

  #define DEFINE_SU_TYPE(TYPENAME) \
    typedef struct {               \
      void* ptr;                   \
    } TYPENAME;

#endif  // DOXYGEN_SHOULD_SKIP_THIS

#define SU_RESULT SU_EXPORT enum SUResult

#define SU_INVALID \
  { 0 }

#define SUIsValid(VARIABLE) ((VARIABLE).ptr != 0)

#define SUIsInvalid(VARIABLE) ((VARIABLE).ptr == 0)

#define SUSetInvalid(VARIABLE) (VARIABLE).ptr = 0

#define SUAreEqual(VARIABLE1, VARIABLE2) ((VARIABLE1).ptr == (VARIABLE2).ptr)

#include <stddef.h>  // for size_t

#if !defined(__STDC_HOSTED__) || (__STDC_HOSTED__ == 0)
  // The host compiler does not implement C99
  #ifdef WIN32
typedef __int64 int64_t;
typedef __int32 int32_t;
typedef __int16 int16_t;
typedef unsigned __int32 uint32_t;
  #else
    #error Unsupported compiler!
  #endif
#else
  #include <stdint.h>
#endif  // #if !defined(__STDC_HOSTED__) || (__STDC_HOSTED__ == 0)

#ifndef __cplusplus
  // C compilers need this header for the bool type.
  // This header maps bool to C99's _Bool type.
  #include <stdbool.h>
#endif

#ifndef SU_SUPPRESS_DEPRECATION_WARNINGS
  #ifdef WIN32
    #define SU_DEPRECATED_FUNCTION(version_num) \
      __declspec(deprecated("first deprecated in " version_num))
  #else
    #define SU_DEPRECATED_FUNCTION(version_num) \
      __attribute__((deprecated("first deprecated in " version_num)))
  #endif
#else
  #define SU_DEPRECATED_FUNCTION(version_num)
#endif

#endif  // SKETCHUP_COMMON_H_