ElementaryFile.hpp

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2025 Calypso Networks Association https://calypsonet.org/    *
 *                                                                            *
 * This program and the accompanying materials are made available under the   *
 * terms of the MIT License which is available at                             *
 * https://opensource.org/licenses/MIT.                                       *
 *                                                                            *
 * SPDX-License-Identifier: MIT                                               *
 ******************************************************************************/
 
#pragma once
 
#include <cstdint>
#include <iomanip>
#include <memory>
#include <ostream>
#include <sstream>
#include <vector>
 
#include "keypop/calypso/card/card/FileData.hpp"
 
namespace keypop {
namespace calypso {
namespace card {
namespace card {
 
class FileHeader;
 
class ElementaryFile {
public:
    enum Type {
        LINEAR,
 
        BINARY,
 
        CYCLIC,
 
        COUNTERS,
 
        SIMULATED_COUNTERS
    };
 
    virtual uint8_t getSfi() const = 0;
 
    virtual std::shared_ptr<FileHeader> getHeader() const = 0;
 
    virtual const std::shared_ptr<FileData> getData() const = 0;
 
    friend std::ostream&
    operator<<(std::ostream& os, const ElementaryFile& ef) {
        /*
         * The SFI is formatted apart: streamed as a uint8_t it would come out
         * as a character, and most SFI values are not printable.
         */
        std::ostringstream sfi;
        sfi << std::uppercase << std::hex << std::setfill('0') << std::setw(2)
            << static_cast<int>(ef.getSfi());
 
        os << "ELEMENTARY_FILE: {"
           << "SFI: " << sfi.str() << "h";
 
        /*
         * A header is reported as present only. FileHeader includes this header
         * for the Type enumeration, so it is an incomplete type here and cannot
         * be rendered; print the header itself to see its fields.
         */
        if (ef.getHeader() != nullptr) {
            os << ", HEADER: set";
        }
 
        os << ", " << ef.getData() << "}";
 
        return os;
    }
 
    friend std::ostream&
    operator<<(std::ostream& os, const std::shared_ptr<ElementaryFile> ef) {
        if (ef == nullptr) {
            os << "ELEMENTARY_FILE: null";
        } else {
            os << *ef.get();
        }
 
        return os;
    }
 
    friend std::ostream&
    operator<<(
        std::ostream& os,
        const std::vector<std::shared_ptr<ElementaryFile>>& ef) {
        os << "ELEMENTARY_FILES: {";
 
        for (auto it = ef.begin(); it != ef.end(); it++) {
            if (it != ef.begin()) {
                os << ", ";
            }
 
            os << *it;
        }
 
        os << "}";
 
        return os;
    }
};
 
} /* namespace card */
} /* namespace card */
} /* namespace calypso */
} /* namespace keypop */