SBSCommon.h

Go to the documentation of this file.

//  ScanditSDKCommon.h
//  ScanditBarcodeScanner
//
//  Created by Marco Biasini on 29/05/15.
//  Copyright (c) 2015 Scandit AG. All rights reserved.
//


#define SBS_DEPRECATED __attribute__((deprecated))

// we can't use NS_ENUM directly, but rather have to use a macro that gets replaced with
// the proper meaning when generating the documentation.

#if defined(SBS_GENERATE_DOCS)
#   define SBS_ENUM_BEGIN(name) typedef enum
#   define SBS_ENUM_END(name) name
#   define SBS_DESIGNATED_INITIALIZER
#   define SBS_NOT_AVAILABLE_IN_SWIFT
#   define SBS_SWIFT_NAME(method)
#   define SBS_DEPRECATED_MSG_ATTRIBUTE(message)
#else
#   define SBS_ENUM_BEGIN(name) typedef NS_ENUM(NSInteger, name)
#   define SBS_ENUM_END(name)
#   define SBS_DESIGNATED_INITIALIZER NS_DESIGNATED_INITIALIZER
#   if __has_attribute(swift_private)
#     define SBS_NOT_AVAILABLE_IN_SWIFT __attribute__((swift_private))
#   endif
#   define SBS_SWIFT_NAME(method) NS_SWIFT_NAME(method)
#   define SBS_DEPRECATED_MSG_ATTRIBUTE(message) DEPRECATED_MSG_ATTRIBUTE(message)
#endif


SBS_ENUM_BEGIN(SBSCameraFacingDirection) {
    SBSCameraFacingDirectionBack, 
    SBSCameraFacingDirectionFront, 
    CAMERA_FACING_BACK SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSCameraFacingDirectionBack,
    CAMERA_FACING_FRONT SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSCameraFacingDirectionFront,
} SBS_ENUM_END(SBSCameraFacingDirection);

typedef SBSCameraFacingDirection CameraFacingDirection SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT;


SBS_ENUM_BEGIN(SBSOrientation)  {
    SBSOrientationPortrait,
    SBSOrientationLandscape,
    ORIENTATION_PORTRAIT SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSOrientationPortrait,
    ORIENTATION_LANDSCAPE SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSOrientationLandscape
} SBS_ENUM_END(SBSOrientation);

typedef SBSOrientation Orientation SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT;


SBS_ENUM_BEGIN(SBSWorkingRange) {
    SBSWorkingRangeStandard,
    SBSWorkingRangeLong,
    STANDARD_RANGE SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSWorkingRangeStandard,
    LONG_RANGE SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT = SBSWorkingRangeLong,
    HIGH_DENSITY SBS_DEPRECATED
} SBS_ENUM_END(SBSWorkingRange);

typedef SBSWorkingRange WorkingRange SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT;

SBS_ENUM_BEGIN(SBSMsiPlesseyChecksumType) {
    SBSMsiPlesseyChecksumTypeNone,
    SBSMsiPlesseyChecksumTypeMod10, 
    SBSMsiPlesseyChecksumTypeMod1010,
    SBSMsiPlesseyChecksumTypeMod11,
    SBSMsiPlesseyChecksumTypeMod1110,
    
    NONE SBS_NOT_AVAILABLE_IN_SWIFT SBS_DEPRECATED  = SBSMsiPlesseyChecksumTypeNone,
    CHECKSUM_MOD_10 SBS_NOT_AVAILABLE_IN_SWIFT SBS_DEPRECATED = SBSMsiPlesseyChecksumTypeMod10,
    CHECKSUM_MOD_1010 SBS_NOT_AVAILABLE_IN_SWIFT SBS_DEPRECATED = SBSMsiPlesseyChecksumTypeMod1010,
    CHECKSUM_MOD_11 SBS_NOT_AVAILABLE_IN_SWIFT SBS_DEPRECATED = SBSMsiPlesseyChecksumTypeMod11,
    CHECKSUM_MOD_1110 SBS_NOT_AVAILABLE_IN_SWIFT SBS_DEPRECATED = SBSMsiPlesseyChecksumTypeMod1110
} SBS_ENUM_END(SBSMsiPlesseyChecksumType);

typedef SBSMsiPlesseyChecksumType MsiPlesseyChecksumType SBS_DEPRECATED SBS_NOT_AVAILABLE_IN_SWIFT;


SBS_ENUM_BEGIN(SBSGuiStyle) {
    SBSGuiStyleDefault,
    SBSGuiStyleLaser,
    SBSGuiStyleNone,
    SBSGuiStyleMatrixScan,
    SBSGuiStyleLocationsOnly,
} SBS_ENUM_END(SBSGuiStyle);


FOUNDATION_EXPORT NSString * const SBSErrorDomain;

SBS_ENUM_BEGIN(SBSError) {
    SBSErrorInvalidArgument = 1
} SBS_ENUM_END(SBSError);