ReaderOptions.h

Go to the documentation of this file.

/*
* Copyright 2016 Nu-book Inc.
* Copyright 2016 ZXing authors
* Copyright 2020 Axel Waggershauser
*/
// SPDX-License-Identifier: Apache-2.0
 
#pragma once
 
#include "BarcodeFormat.h"
#include "CharacterSet.h"
#include "Version.h"
 
#include <string_view>
#include <utility>
#include <memory>
 
namespace ZXing {

enum class Binarizer : unsigned char // needs to be unsigned for the bitfield below to work, uint8_t fails as well
{
    LocalAverage,    
    GlobalHistogram, 
    FixedThreshold,  
    BoolCast,        
};
 
enum class EanAddOnSymbol : unsigned char // see above
{
    Ignore,  
    Read,    
    Require, 
};

enum class TextMode : unsigned char // see above
{
    Plain,   
    ECI,     
    HRI,     
    Escaped, 
    Hex,     
    HexECI,  
};

class ReaderOptions
{
    struct Data;
    std::unique_ptr<Data> d;
 
public:
    ReaderOptions();
    ~ReaderOptions();
    ReaderOptions(const ReaderOptions&);
    ReaderOptions& operator=(const ReaderOptions&);
    ReaderOptions(ReaderOptions&&) noexcept;
    ReaderOptions& operator=(ReaderOptions&&) noexcept;
 
#define ZX_PROPERTY(TYPE, NAME, SETTER, ...) \
    TYPE NAME() const noexcept; \
    __VA_ARGS__ ReaderOptions& NAME(TYPE v) &; \
    __VA_ARGS__ ReaderOptions&& NAME(TYPE v) &&; \
    __VA_ARGS__ inline ReaderOptions& SETTER(TYPE v) & { return NAME(v); } \
    __VA_ARGS__ inline ReaderOptions&& SETTER(TYPE v) && { return std::move(*this).NAME(v); }

    const BarcodeFormats& formats() const noexcept;
    ReaderOptions& formats(BarcodeFormats&& v) &;
    ReaderOptions&& formats(BarcodeFormats&& v) &&;
    ReaderOptions& formats(const BarcodeFormats& v) & { return formats(BarcodeFormats(v)); }
    ReaderOptions&& formats(const BarcodeFormats& v) && { return std::move(*this).formats(BarcodeFormats(v)); }
    inline ReaderOptions& setFormats(BarcodeFormats&& v) & { return formats(std::move(v)); }
    inline ReaderOptions&& setFormats(BarcodeFormats&& v) && { return std::move(*this).formats(std::move(v)); }
    inline ReaderOptions& setFormats(const BarcodeFormats& v) & { return formats(BarcodeFormats(v)); }
    inline ReaderOptions&& setFormats(const BarcodeFormats& v) && { return std::move(*this).formats(BarcodeFormats(v)); }

    ZX_PROPERTY(bool, tryHarder, setTryHarder)
 
    
    ZX_PROPERTY(bool, tryRotate, setTryRotate)

    ZX_PROPERTY(bool, tryInvert, setTryInvert)

    ZX_PROPERTY(bool, tryDownscale, setTryDownscale)
 
#ifdef ZXING_EXPERIMENTAL_API
    ZX_PROPERTY(bool, tryDenoise, setTryDenoise)
#endif

    ZX_PROPERTY(Binarizer, binarizer, setBinarizer)
 
    
    ZX_PROPERTY(bool, isPure, setIsPure)

    ZX_PROPERTY(uint16_t, downscaleThreshold, setDownscaleThreshold)

    ZX_PROPERTY(uint8_t, downscaleFactor, setDownscaleFactor)

    ZX_PROPERTY(uint8_t, minLineCount, setMinLineCount)

    ZX_PROPERTY(uint8_t, maxNumberOfSymbols, setMaxNumberOfSymbols)

    ZX_PROPERTY(bool, validateOptionalChecksum, setValidateOptionalChecksum)

    ZX_PROPERTY(bool, returnErrors, setReturnErrors)

    ZX_PROPERTY(EanAddOnSymbol, eanAddOnSymbol, setEanAddOnSymbol)

    ZX_PROPERTY(TextMode, textMode, setTextMode)

    ZX_PROPERTY(CharacterSet, characterSet, setCharacterSet)
    ReaderOptions& characterSet(std::string_view v) &;
    ReaderOptions&& characterSet(std::string_view v) &&;
    inline ReaderOptions& setCharacterSet(std::string_view v) & { return characterSet(v); }
    inline ReaderOptions&& setCharacterSet(std::string_view v) && { return std::move(*this).characterSet(v); }
 
#undef ZX_PROPERTY

 
    // Silence deprecated-declarations warnings, only happening here for deprecated inline functions
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#elif defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4996)
#endif
 
#define ZX_DEPRECATED_PROPERTY(TYPE, NAME, SETTER, GET_IMPL, SET_IMPL) \
    [[deprecated]] inline TYPE NAME() const noexcept { return GET_IMPL; } \
    [[deprecated]] ReaderOptions& NAME(TYPE v) & { SET_IMPL; return *this; } \
    [[deprecated]] ReaderOptions&& NAME(TYPE v) && { SET_IMPL; return std::move(*this); } \
    [[deprecated]] inline ReaderOptions& SETTER(TYPE v) & { return NAME(v); } \
    [[deprecated]] inline ReaderOptions&& SETTER(TYPE v) && { return std::move(*this).NAME(v); }

    ZX_DEPRECATED_PROPERTY(bool, tryCode39ExtendedMode, setTryCode39ExtendedMode, true, (void)v)
 
    
    ZX_DEPRECATED_PROPERTY(bool, validateCode39CheckSum, setValidateCode39CheckSum, validateOptionalChecksum(),
                           validateOptionalChecksum(v))
 
    
    ZX_DEPRECATED_PROPERTY(bool, validateITFCheckSum, setValidateITFCheckSum, validateOptionalChecksum(), validateOptionalChecksum(v))
 
#undef ZX_DEPRECATED_PROPERTY
 
#ifdef __GNUC__
#pragma GCC diagnostic pop
#elif defined(_MSC_VER)
#pragma warning(pop)
#endif

 
#ifdef ZXING_INTERNAL
    bool hasFormat(const BarcodeFormats& formats) const noexcept;

    bool hasAnyFormat(const BarcodeFormats& formats) const noexcept;
#endif
};
 
} // ZXing