Barcode.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 "ContentType.h"
#include "Error.h"
#include "ImageView.h"
#include "Quadrilateral.h"
#include "ReaderOptions.h" // for TextMode
#include "Version.h" // ZXING_... macros
 
#include <memory>
#include <string>
#include <vector>
 
#ifdef ZXING_USE_ZINT
extern "C" struct zint_symbol;
#endif
 
namespace ZXing {
 
class CreatorOptions;
class ReaderOptions;
class WriterOptions;
class Barcode;
struct BarcodeData;
 
using Position = QuadrilateralI;
using Barcodes = std::vector<Barcode>;

namespace BarcodeExtra {
    #define ZX_EXTRA(NAME) static constexpr auto NAME = #NAME
    ZX_EXTRA(DataMask); 
    ZX_EXTRA(Version);  
    ZX_EXTRA(EanAddOn); 
    ZX_EXTRA(ECLevel);  
    ZX_EXTRA(UPCE);     
    ZX_EXTRA(ReaderInit);
    #undef ZX_EXTRA
} // namespace BarcodeExtra

class Barcode
{
    using Data = BarcodeData;
 
    std::shared_ptr<Data> d;
 
    Barcode& setReaderOptions(const ReaderOptions& opts);
 
    friend Barcode MergeStructuredAppendSequence(const Barcodes&);
    friend Barcodes ReadBarcodes(const ImageView&, const ReaderOptions&);
    friend Barcode CreateBarcode(const void*, int, int, const CreatorOptions&);
    friend Image WriteBarcodeToImage(const Barcode&, const WriterOptions&);
    friend std::string WriteBarcodeToSVG(const Barcode&, const WriterOptions&);
 
public:
    Barcode();
    Barcode(Barcode::Data&& data);

    bool isValid() const;

    const Error& error() const;

    BarcodeFormat format() const;

    BarcodeFormat symbology() const { return Symbology(format()); }

    const std::vector<uint8_t>& bytes() const;

    std::vector<uint8_t> bytesECI() const;

    std::string text(TextMode mode) const;

    std::string text() const;

    ContentType contentType() const;

    bool hasECI() const;

    const Position& position() const;

    int orientation() const;

    bool isMirrored() const;
    bool isInverted() const;

    std::string symbologyIdentifier() const;

    int sequenceSize() const;

    int sequenceIndex() const;

    std::string sequenceId() const;

    bool isLastInSequence() const { return sequenceSize() == sequenceIndex() + 1; }

    bool isPartOfSequence() const { return sequenceSize() > -1 && sequenceIndex() > -1; }

    int lineCount() const;

    ImageView symbol() const;

    std::string extra(std::string_view key = "") const;

    // [[deprecated ("use extra(BarcodeExtra::ECLevel) instead")]]
    std::string ecLevel() const { return extra(BarcodeExtra::ECLevel); }

    // [[deprecated ("use extra(BarcodeExtra::ReaderInit) instead")]]
    bool readerInit() const { return !extra(BarcodeExtra::ReaderInit).empty(); }

    // [[deprecated ("use extra(BarcodeExtra::Version) instead")]]
    std::string version() const { return extra(BarcodeExtra::Version); }
 
#if defined(ZXING_USE_ZINT) && defined(ZXING_EXPERIMENTAL_API)
    zint_symbol* zint() const;
#endif
 
    bool operator==(const Barcode& o) const;
};

Barcode MergeStructuredAppendSequence(const Barcodes& barcodes);

Barcodes MergeStructuredAppendSequences(const Barcodes& barcodes);
 
} // ZXing