column.h

#pragma once
 
// Application headers
namespace ehm_dal::tables {
class AbstractTable;
enum class TableIndex : char;
}
 
// Qt headers
#include <QString>
 
namespace ehm_dal::column_data {
 
// --- Column index/data --- //
class Column
{
public:
    // Settings
    enum COLUMN_SETTINGS {
        NO_SETTINGS = 1 << 0,
        HIDE_EVERYWHERE = 1 << 1,   
        HIDE_FROM_FILTERS = 1 << 2, 
        HIDE_FROM_TABLES = 1 << 3,  
        HIDE_FROM_UI = 1 << 4,      
        HIDE_FROM_UI_AND_TABLES = 1 << 5, 
        READ_ONLY = 1 << 6,               
        COLOUR_POINTER = 1 << 7,          
        NAME_STRING_POINTER = 1 << 8,     
        POINTER_LIST = 1 << 9,            
        RAW_POINTER = 1 << 10,            
        CACHED_COLUMN = 1 << 11           
    };
 
    // Column types
    enum class ColumnType : quint8 {
        // Bool
        BOOL,
        // Containers
        CONTAINER,
        // Date
        DATE,
        YEAR,
        // Numerical
        ATTRIBUTE_20,
        ATTRIBUTE_99,
        ATTRIBUTE_200,
        ATTRIBUTE_POTENTIAL,
        CHAR,
        UCHAR,
        CURRENCY,
        DOUBLE,
        FLOAT,
        INT,
        UINT,
        SHORT,
        USHORT,
        // Pointer
        FLAG,
        POINTER,
        POINTER_BITMASK_FLAG_TABLE,
        POINTER_COLOUR_TABLE,
        POINTER_DATABASE_TABLE,
        POINTER_FLAG_TABLE,
        POINTER_LIST,
        RAW_POINTER,
        // Primary key
        PRIMARY_KEY_ID,
        PRIMARY_KEY_UID,
        // Special
        EXTRA_RULES,
        // Text
        STRING
    };
 
    Column();
    // Non-pointer constructor
    Column(const qint32 position,
           const QString &name,
           const ColumnType type,
           const quint16 settings = NO_SETTINGS);
    // Pointer constructor
    Column(const qint32 position,
           const QString &name,
           std::shared_ptr<ehm_dal::tables::AbstractTable> table,
           const quint16 settings = NO_SETTINGS);
 
    // Get data - basic attributes
    Qt::ItemFlags flags() const;
    inline qint32 id() const { return position_; } // Column position/index
    inline QString name() const { return name_; }  // Column name
    Q_DECL_DEPRECATED inline qint32 position() const
    {
        return id();
    } // Column position/index (to be deprecated)
 
    // Get data - general attributes
    inline bool isCached() const { return (settings_ & CACHED_COLUMN); }
    inline bool isCheckable() const { return type_ == ColumnType::BOOL; }
    inline bool isContainer() const { return type_ == ColumnType::CONTAINER; }
    inline bool isReadOnly() const { return (settings_ & READ_ONLY); }
 
    // Get data - table pointer
    inline bool isColourPointer() const { return (settings_ & COLOUR_POINTER); }
    bool isDatabaseTablePointer() const;
    bool isFlagTablePointer() const;
    inline bool isNameStringPointer() const { return (settings_ & NAME_STRING_POINTER); }
    inline bool isPointerList() const { return (settings_ & POINTER_LIST); }
    inline bool isRawPointer() const { return (settings_ & RAW_POINTER); }
    ehm_dal::tables::TableIndex relatedTableIndex() const;
    QString relatedTableName() const;
 
    // Get data - visibility
    inline bool hiddenEverywhere() const { return (settings_ & HIDE_EVERYWHERE); }
    inline bool hiddenFromFilters() const
    {
        return (settings_ & HIDE_FROM_FILTERS) || hiddenEverywhere();
    }
    inline bool hiddenFromTables() const
    {
        return (settings_ & HIDE_FROM_TABLES) || (settings_ & HIDE_FROM_UI_AND_TABLES)
               || hiddenFromFilters();
    }
    inline bool hiddenFromUi() const
    {
        return (settings_ & HIDE_FROM_UI_AND_TABLES) || (settings_ & HIDE_FROM_UI)
               || hiddenEverywhere();
    }
    inline bool visibleToFilters() const { return !hiddenFromFilters(); }
 
private:
    enum ENUM_FLAGS { NO_COLUMN_INDEX = -1 }; // Private magic number
 
    // Attributes
    qint32 position_{NO_COLUMN_INDEX};
    QString name_{QStringLiteral("No column name")};
    quint16 settings_{NO_SETTINGS};
    ColumnType type_;
 
    // Table pointer
    std::shared_ptr<ehm_dal::tables::AbstractTable> table_;
    void initTablePointer();
 
    // Settings
    void initSettings();
};
 
} // namespace ehm_dal::column_data