akCore.h

Go to the documentation of this file.

/*
 *  File:       akCore.h
 *  Package:    akCore
 *
 *  Created on: February 06, 2020
 *  Author: Alexander Kuester
 *  Copyright (c) 2022 Alexander Kuester
 *  This file is part of the uiCore component.
 *  This file is subject to the terms and conditions defined in
 *  file 'LICENSE', which is part of this source code package.
 */
 
#pragma once
 
 // AK header
#include <akCore/globalDataTypes.h>
#include "OTCore/Flags.h"
 
 // Qt header
#include <QtCore/qstring.h>     // QString
#include <QtCore/qflags.h>          // QFlags
#include <QtCore/qcryptographichash.h>
 
// C++ header
#include <vector>                   // vector<T>
#include <list>                     // list<T>
#include <string>
#include <sstream>
 
// Forward declaration
class QKeyEvent;
 
namespace ak {
 
    enum colorAreaFlag {
        cafBackgroundColorWindow = 1 << 0,
        cafForegroundColorWindow = 1 << 1,
        cafBorderColorWindow = 1 << 2,
        cafBackgroundColorHeader = 1 << 3,
        cafForegroundColorHeader = 1 << 4,
        cafBorderColorHeader = 1 << 5,
        cafBackgroundColorControls = 1 << 6,
        cafForegroundColorControls = 1 << 7,
        cafBorderColorControls = 1 << 8,
        cafDefaultBorderControls = 1 << 9,
        cafDefaultBorderWindow = 1 << 10,
        cafBackgroundColorAlternate = 1 << 11,
        cafForegroundColorError = 1 << 12,
        cafBackgroundColorFocus = 1 << 13,
        cafBackgroundColorSelected = 1 << 14,
        cafForegroundColorFocus = 1 << 15,
        cafForegroundColorSelected = 1 << 16,
        cafBackgroundColorTransparent = 1 << 17,
        cafImagesTree = 1 << 18,
        cafImagesDock = 1 << 19,
        cafDefaultBorderHeader = 1 << 20,
        cafBackgroundColorDialogWindow = 1 << 21,
        cafForegroundColorDialogWindow = 1 << 22,
        cafBackgroundColorButton = 1 << 23,
        cafForegroundColorButton = 1 << 24,
        cafTabToolBarGroupSeperatorLine = 1 << 25,
        cafBackgroundColorView = 1 << 26
    };
 
    enum commandType {
        ctClearCreatedObjects
    };
 
    enum dateFormat {
        dfDDMMYYYY,
        dfMMDDYYYY,
        dfYYYYMMDD,
        dfYYYYDDMM
    };
 
    enum dockLocation {
        dockLeft,
        dockRight,
        dockBottom
    };
 
    enum eventType : unsigned long long {
        etUnknownEvent = 1 << 0,
        etActivated = 1 << 1,
        etChanged = 1 << 2,
        etCleared = 1 << 3,
        etClicked = 1 << 4,
        etClosing = 1 << 5,
        etCollpased = 1 << 6,
        etCursorPosotionChanged = 1 << 7,
        etDestroyed = 1 << 8,
        etDoubleClicked = 1 << 9,
        etExpanded = 1 << 10,
        etFocused = 1 << 11,
        etFocusLeft = 1 << 12,
        etInvalidEntry = 1 << 13,
        etIndexChanged = 1 << 14,
        etItemChanged = 1 << 15,
        etItemTextChanged = 1 << 16,
        etKeyPressed = 1 << 17,
        etKeyReleased = 1 << 18,
        etLocationChanged = 1 << 19,
        etSelectionChanged = 1 << 20,
        etStateChanged = 1 << 21,
        etTabToolbarChanged = 1 << 22,
        etTabToolbarClicked = 1 << 23,
        etTimeout = 1 << 24,
        etToggeledChecked = 1 << 25,
        etToggeledUnchecked = 1 << 26,
        etVisibilityChanged = 1 << 27,
        etReturnPressed = 1 << 28,
        etEditingFinished = 1 << 29,
        etDeleted = (unsigned long long ) (1) << 32
    };
 
    enum HashAlgorithm
    {
        hashKeccak_224,
        hashKeccak_256,
        hashKeccak_384,
        hashKeccak_512,
        hashMd4,
        hashMd5,
        hashRealSha3_224,
        hashRealSha3_256,
        hashRealSha3_384,
        hashRealSha3_512,
        hashSha1,
        hashSha_224,
        hashSha_256,
        hashSha_384,
        hashSha3_224,
        hashSha3_256,
        hashSha3_384,
        hashSha3_512,
        hashSha512
    };
 
    enum keyType {
        keyUnknown,
        keyAlt,
        keyAltGr,
        keyControl,
        keyDelete,
        keyEscape,
        keyF1,
        keyF10,
        keyF11,
        keyF12,
        keyF2,
        keyF3,
        keyF4,
        keyF5,
        keyF6,
        keyF7,
        keyF8,
        keyF9,
        keyReturn,
        keySpace
    };
 
    enum objectType {
        otNone,
        otAction,
        otCheckBox,
        otLabel,
        otLineEdit,
        otMainWindow,
        otMenu,
        otNiceLineEdit,
        otTabToolbar,
        otTabToolbarGroup,
        otTabToolbarPage,
        otTabToolbarSubgroup,
        otTimer,
        otToolButton,
        otTree,
        otTreeItem
    };
 
    enum promptType {
        promptOk,
        promptYesNo,
        promptYesNoCancel,
        promptOkCancel,
        promptRetryCancel,
        promptIgnoreRetryCancel,
        promptIconLeft,
        promptOkCancelIconLeft,
        promptOkIconLeft,
        promptYesNoIconLeft,
        promptYesNoCancelIconLeft
    };
    
    enum tabLocation {
        tabLocationUp,
        tabLocationDown,
        tabLocationLeft,
        tabLocationRight
    };
 
    enum textAlignment {
        alignLeft,
        alignRight,
        alignCenter
    };
 
    enum timeFormat {
        tfHHMM,
        tfHHMMSS,
        tfHHMMSSMMMM
    };
 
    enum valueType {
        vtArray,
        vtBool,
        vtColor,
        vtDate,
        vtDouble,
        vtFloat,
        vtInt,
        vtInt64,
        vtLosslessDouble,
        vtLosslessFloat,
        vtNull,
        vtNumber,
        vtObject,
        vtSelection,
        vtString,
        vtTime,
        vtUint,
        vtUint64
    };
 
    inline eventType operator | (eventType a, eventType b)
    {
        return static_cast<eventType>(static_cast<int>(a) | static_cast<int>(b));
    }
 
    inline colorAreaFlag operator | (colorAreaFlag a, colorAreaFlag b)
    {
        return static_cast<colorAreaFlag>(static_cast<int>(a) | static_cast<int>(b));
    }
 
    inline bool flagIsSet(colorAreaFlag _flags, colorAreaFlag _testFlag) { return ((_flags & _testFlag) == _testFlag); }
 
    // ############################################################################################################################################
 
    // Converting
 
    UICORE_API_EXPORT QString toQString(
        eventType                               _eventType
    );
 
    UICORE_API_EXPORT QString toQString(
        valueType                               _valueType
    );
    
    UICORE_API_EXPORT std::vector<int> toCharIndex(
        const char *                    str
    );
 
    UICORE_API_EXPORT QCryptographicHash::Algorithm toQCryptographicHashAlgorithm(HashAlgorithm _algorhitm);
 
    UICORE_API_EXPORT QString hashString(const QString & _str, HashAlgorithm _algorhitm);
 
    template <class T> std::vector<T> toVector(const std::list<T> & _list) {
        std::vector<T> ret;
        ret.reserve(_list.size());
        for (auto itm : _list) { ret.push_back(itm); }
        return ret;
    }
 
    UICORE_API_EXPORT QString toQString(
        objectType                              _objectType
    );
 
    UICORE_API_EXPORT QString toQString(
        textAlignment                           _textAlignment
    );
 
    UICORE_API_EXPORT QString toQString(
        tabLocation                             _tabLocation
    );
 
    UICORE_API_EXPORT QString toQString(
        dockLocation                            _dockLocation
    );
 
    UICORE_API_EXPORT QString toQString(
        promptType                              _promptType
    );
 
    UICORE_API_EXPORT QString toQString(
        keyType                                 _keyType
    );
 
    UICORE_API_EXPORT QString toQString(
        dateFormat                              _dateFormat
    );
 
    UICORE_API_EXPORT QString toQString(
        timeFormat                              _timeFormat
    );
 
    // Converting
 
    // ############################################################################################################################################
 
    // Parsing
 
    UICORE_API_EXPORT keyType toKeyType(
        QKeyEvent *                             _event
    );
 
    UICORE_API_EXPORT Qt::AlignmentFlag toQtAlignmentFlag(
        textAlignment                           _textAlignment
    );
 
    UICORE_API_EXPORT dateFormat toDateFormat(const QString& _str);
 
    UICORE_API_EXPORT timeFormat toTimeFormat(const QString& _str);
 
    // Parsing
 
    // ############################################################################################################################################
 
    // Type checking
 
    template <class T> T toNumber(const std::string& _string, bool & _failed) {
        std::stringstream ss(_string);
        T v;
        ss >> v;
        _failed = false;
        if (ss.fail()) { _failed = true; }
        std::string rest;
        ss >> rest;
        if (!rest.empty()) { _failed = true; }
        return v;
    }
 
    template <class T> T toNumber(const QString& _string, bool & _failed) {
        return toNumber<T>(_string.toStdString(), _failed);
    }
 
    template <class T> T toNumber(const char* _string, bool & _failed) {
        return toNumber<T>(std::string(_string), _failed);
    }
 
    UICORE_API_EXPORT bool isDecimal(const char *str);
 
    UICORE_API_EXPORT bool isDecimal(const std::string &str);
 
    UICORE_API_EXPORT bool isDecimal(const QString &str);
 
    UICORE_API_EXPORT bool isInteger(const char *str);
 
    UICORE_API_EXPORT bool isInteger(const std::string &str);
 
    UICORE_API_EXPORT bool isInteger(const QString &str);
 
    UICORE_API_EXPORT bool isNumericOnly(const char *str);
 
    UICORE_API_EXPORT bool isNumericOnly(const std::string &str);
 
    UICORE_API_EXPORT bool isNumericOnly(const QString &str);
 
} // namespace ak