common/lib/format_int.h

/*
 * SPDX-FileCopyrightText: 2022 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_COMMON_LIB_FORMAT_INT_H_
#define BACKENDS_P4TOOLS_COMMON_LIB_FORMAT_INT_H_
 
#include <stddef.h>
 
#include <string>
 
#include "ir/ir.h"
#include "lib/big_int_util.h"
 
namespace P4::P4Tools {

struct FormatOptions {
    bool useSeparator = false;

    bool padOutput = true;

    bool usePrefix = true;

    bool useUpperCaseHex = true;
};

std::string formatBinOrHex(const big_int &value,
                           const FormatOptions &formatOptions = FormatOptions());

std::string formatBin(const big_int &value, int width,
                      const FormatOptions &formatOptions = FormatOptions());

std::string formatOctal(const big_int &value, const FormatOptions &formatOptions = FormatOptions());

std::string formatHex(const big_int &value, int width,
                      const FormatOptions &formatOptions = FormatOptions());

std::string formatBinOrHexExpr(const IR::Expression *expr,
                               const FormatOptions &formatOptions = FormatOptions());

std::string formatBinExpr(const IR::Expression *expr,
                          const FormatOptions &formatOptions = FormatOptions());

std::string formatOctalExpr(const IR::Expression *expr,
                            const FormatOptions &formatOptions = FormatOptions());

std::string formatHexExpr(const IR::Expression *expr,
                          const FormatOptions &formatOptions = FormatOptions());

std::string insertSeparators(const std::string &dataStr, const std::string &separator = "\\x",
                             size_t stride = 2, bool skipFirst = false);

std::string insertOctalSeparators(const std::string &dataStr);

std::string insertHexSeparators(const std::string &dataStr);

std::vector<uint8_t> convertBigIntToBytes(const big_int &dataInt, int targetWidthBits,
                                          bool padLeft = false);

std::optional<std::string> convertToIpv4String(const std::vector<uint8_t> &byteArray);

std::optional<std::string> convertToIpv6String(const std::vector<uint8_t> &byteArray);

std::optional<std::string> convertToMacString(const std::vector<uint8_t> &byteArray);
 
}  // namespace P4::P4Tools
 
#endif /* BACKENDS_P4TOOLS_COMMON_LIB_FORMAT_INT_H_ */