pythonWorkspace.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2023, Institut für Technische Optik (ITO),
    Universität Stuttgart, Germany
 
    This file is part of itom.
 
    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
 
    itom is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
    General Public Licence for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */
 
#pragma once
 
#ifndef Q_MOC_RUN
    #define PY_ARRAY_UNIQUE_SYMBOL itom_ARRAY_API //see numpy help ::array api :: Miscellaneous :: Importing the api (this line must before include global.h)
    #define NO_IMPORT_ARRAY
 
    #include "pythonWrapper.h"
#endif
 
#include "../global.h"
 
#include <qstring.h>
#include <qhash.h>
#include <qmutex.h>
#include <qchar.h>
#include <qset.h>
#include <qstringlist.h>
#include <qobject.h>
 
// type of outer container
#define PY_LIST_TUPLE 'l'
#define PY_MAPPING 'm'
#define PY_ATTR 'a'
#define PY_DICT 'd'
 
// type of key
#define PY_NUMBER 'n'
#define PY_STRING 's'
#define PY_OBJID 'h' // object id (ptr) as hex for all other objects
 
namespace ito
{
 
class PyWorkspaceItem;
 
//----------------------------------------------------------------------------------------------------------------------------------
class PyWorkspaceItem
{
public:
    PyWorkspaceItem() : m_compatibleParamBaseType(0), m_exist(false), m_isarrayelement(false), m_childState(stateNoChilds)
    {
    }
    ~PyWorkspaceItem();
    PyWorkspaceItem(const PyWorkspaceItem &other);
 
    enum ChildState
    {
        stateNoChilds = 0x00, 
        stateChilds = 0x01    
    };
 
    QString m_name; 
    QString m_key;  
    QString m_type; 
    QString m_value;
    QString m_extendedValue;
    int m_compatibleParamBaseType; 
    bool m_exist;
    bool m_isarrayelement; 
    ChildState m_childState; 
    QHash<QString, PyWorkspaceItem*> m_childs;
};
 
 
class PyWorkspaceContainer : public QObject //each container has one view
{
    Q_OBJECT
public:
 
    PyWorkspaceContainer(bool globalNotLocal);
    ~PyWorkspaceContainer();
 
    void clear();
    void loadDictionary(PyObject *obj, const QString &fullNameParentItem = "");
 
    inline bool isGlobalWorkspace() const { return m_globalNotLocal; }
    inline bool isRoot(PyWorkspaceItem *item) const { return item == &m_rootItem; }
    inline void emitGetChildNodes(PyWorkspaceContainer *container, QString fullNameParentItem) { emit getChildNodes(container,fullNameParentItem); }
 
    ito::PyWorkspaceItem* getItemByFullName(const QString &fullname);
 
    QMutex m_accessMutex;
    QSet<QString> m_expandedFullNames; //this full names are recently expanded in the corresponding view (full name is "." + name + "." + subname + "." + subsubname ...)
    PyWorkspaceItem m_rootItem;
 
    static QChar delimiter;
 
private:
    void loadDictionaryRec(PyObject *obj, const QString &fullNameParentItem, PyWorkspaceItem *parentItem, QStringList &deletedKeys);
    void parseSinglePyObject(PyWorkspaceItem *item, PyObject *value, const QString &fullName, QStringList &deletedKeys);
 
    bool isNotInBlacklist(PyObject *obj) const;
 
    void appendSlotNamesToList(PyObject *objOrType, PyObject *slotNamesList);
 
    void initUnicodeConstants();
 
    bool m_globalNotLocal;
    PyObject *m_dictUnicode;
    PyObject *m_slotsUnicode;
    PyObject *m_mroUnicode;
 
signals:
    void updateAvailable(PyWorkspaceItem *rootItem, QString fullNameRoot, QStringList recentlyDeletedFullNames);   //TODO
    void getChildNodes(PyWorkspaceContainer *container, QString fullNameParentItem); //signal caught by python    //TODO
};
 
} //end namespace ito