Files
2026-01-13 19:19:42 -05:00

127 lines
3.6 KiB
C++

// Factory.hpp
//
// Copyright (C) 2013-2026 Jaye Evins <evins@snaught.com>
//
// This file is part of glbarcode++.
//
// glbarcode++ 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.
//
// glbarcode++ 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with glbarcode++. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef glbarcode_Factory_hpp
#define glbarcode_Factory_hpp
#include "Barcode.hpp"
#include "TypeIdList.hpp"
#include <string>
#include <map>
namespace glbarcode
{
/**
* @class Factory Factory.h glbarcode/Factory.h
*
* Singleton Barcode factory class.
*/
class Factory
{
public:
/**
* Barcode creation function signature.
*/
using BarcodeCreateFct = Barcode* (*)();
private:
/**
* Barcode factory constructor
*/
Factory();
public:
/**
* Initialize barcode factory.
*
* Initializes the barcode factory and registers all built-in Barcode types. It
* is optional for an application to call init(), because glbarcode++ will automatically
* initialize the factory on demand.
*/
static void init();
/**
* Create barcode based on type ID string.
*
* @param[in] typeId Barcode type ID string
*/
static Barcode* createBarcode( const std::string& typeId );
/**
* Register barcode type ID.
*
* @param[in] typeId Barcode type ID string
* @param[in] fct Function to create barcode object of concrete Barcode class
*/
static void registerType( const std::string& typeId, BarcodeCreateFct fct );
/**
* Is barcode type supported?
*
* @param[in] typeId Barcode type ID string
*/
static bool isTypeSupported( const std::string& typeId );
/**
* Get list of supported types.
*/
static TypeIdList getSupportedTypes();
private:
/**
* Internal register barcode type ID.
*
* @param[in] typeId Barcode type ID string
* @param[in] fct Function to create barcode object of concrete Barcode class
*/
static void internalRegisterType( const std::string& typeId, BarcodeCreateFct fct );
/**
* Map barcode type strings to creation functions.
*/
using BarcodeTypeMap = std::map<std::string,BarcodeCreateFct>;
static BarcodeTypeMap mBarcodeTypeMap;
/**
* Supported barcode types.
*/
static TypeIdList mSupportedTypes;
};
}
#endif // glbarcode_Factory_hpp