TypeDescriptionParser.h

Go to the documentation of this file.

// Copyright (C) 2026 European Spallation Source, ERIC. See LICENSE file
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
#pragma once
 
#include <string>
#include <vector>
#include <stdexcept>
 
#ifdef WIN32
// Export symbols if compile flags "READOUT_SHARED" and "READOUT_EXPORT" are set on Windows.
    #ifdef READOUT_SHARED
        #ifdef READOUT_EXPORT
            #define RL_API __declspec(dllexport)
        #else
            #define RL_API __declspec(dllimport)
        #endif
    #else
        // Disable definition if linking statically.
        #define RL_API
    #endif
#else
// Disable definition for non-Win32 systems.
#define RL_API
#endif
 
struct SchemaField {
  std::string name;
  std::string type;        // Canonical type name, e.g. "int32_t", "double"
  size_t offset;           // Byte offset within the struct
  size_t element_size;     // Size of one element in bytes
  size_t array_count;      // 0 = scalar, N = array of N elements
  size_t alignment;        // Required alignment for this type
 
  size_t total_size() const { return element_size * (array_count > 0 ? array_count : 1); }
};
 
class TypeSchema {
public:
  std::vector<SchemaField> fields;
  size_t total_size;       // Computed total size including padding
  std::string description; // Original description string
 
  TypeSchema() : total_size(0) {}
};
 
class TypeDescriptionError : public std::runtime_error {
public:
  using std::runtime_error::runtime_error;
};
 
RL_API TypeSchema parse_type_description(const std::string& description);