CRegistryCodeSaverComp.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QList>
#include <QtCore/QSet>
#include <QtCore/QTextStream>
 
// ACF includes
#include <icomp/IRegistry.h>
#include <icomp/IExtPackagesManager.h>
#include <icomp/IRegistriesManager.h>
#include <iprm/ISelectionParam.h>
#include <iprm/IOptionsList.h>
#include <ilog/TLoggerCompWrap.h>
#include <ifile/IFilePersistence.h>
#include <ifile/IFileNameParam.h>
 
 
namespace ipackage
{
 
 
class CRegistryCodeSaverComp:
                     public ilog::CLoggerComponentBase,
                     public ifile::IFilePersistence
{
public:
       typedef ilog::CLoggerComponentBase BaseClass;
 
       enum MessageId
       {
              MI_UNDEFINED_PACKAGE = 0x341f0,
              MI_UNDEFINED_COMPONENT,
              MI_UNDEFINED_ATTR_TYPE,
              MI_UNKNOWN_PACKAGE
       };
 
       enum WorkingMode
       {
              WM_SOURCES,
              WM_DEPENDENCIES
       };
 
       I_BEGIN_COMPONENT(CRegistryCodeSaverComp);
              I_REGISTER_INTERFACE(ifile::IFileTypeInfo);
              I_REGISTER_INTERFACE(ifile::IFilePersistence);
              I_REGISTER_INTERFACE(iprm::IOptionsList);
              I_ASSIGN(m_packagesManagerCompPtr, "PackagesManager", "Packages manager providing access to package informations", true, "PackagesManager");
              I_ASSIGN_TO(m_extPackagesManagerCompPtr, m_packagesManagerCompPtr, false);
              I_ASSIGN(m_registriesManagerCompPtr, "RegistriesManager", "Registries manager providing access to all composite component registries", true, "RegistriesManager");
              I_ASSIGN(m_workingModeAttrPtr, "WorkingMode", "Working mode\n\t0 - generate sources\n\t1 - generate dependencies to registries\n\t2 - generate all dependencies", true, 0);
              I_ASSIGN(m_translationLevelAttrPtr, "TranslationLevel", "Level of configuration used for translation all packages, if disabled all levels of used packages will be stored", false, 0);
              I_ASSIGN(m_useBinaryCodeAttrPtr, "UseBinaryCode", "If true, binary serialized registries will be used instead of generated by code", true, false);
              I_ASSIGN(m_depfilePathAttrPtr, "DepfilePath", "Optional path where the dependency file will be stored", false, "");
       I_END_COMPONENT;
 
       CRegistryCodeSaverComp();
 
       // reimplemented (ifile::IFilePersistence)
       virtual bool IsOperationSupported(
                            const istd::IChangeable* dataObjectPtr,
                            const QString* filePathPtr = NULL,
                            int flags = -1,
                            bool beQuiet = true) const override;
       virtual OperationState LoadFromFile(
                            istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const override;
       virtual OperationState SaveToFile(
                            const istd::IChangeable& data,
                            const QString& filePath = QString(),
                            ibase::IProgressManager* progressManagerPtr = NULL) const override;
 
       // reimplemented (ifile::IFileTypeInfo)
       virtual bool GetFileExtensions(QStringList& result, const istd::IChangeable* dataObjectPtr = NULL, int flags = -1, bool doAppend = false) const override;
       virtual QString GetTypeDescription(const QString* extensionPtr = NULL) const override;
 
protected:
       typedef QSet<icomp::CComponentAddress> Addresses;
       typedef QSet<QByteArray> Ids;
 
       bool AppendAddresses(
                            const icomp::IRegistry& registry,
                            const QStringList& registryPath,
                            Addresses& realAddresses,
                            Addresses& composedAddresses) const;
       Ids ExtractPackageIds(const Addresses& addresses) const;
       Ids ExtractComponentIds(const Addresses& addresses, const QByteArray& packageId) const;
 
       bool WriteHeader(
                            const QByteArray& className,
                            const icomp::IRegistry& registry,
                            const Addresses& composedAddresses,
                            const Addresses& realAddresses,
                            QTextStream& stream) const;
       bool WriteIncludes(
                            const QByteArray& className,
                            const Addresses& addresses,
                            QTextStream& stream) const;
       bool WriteClassDefinitions(
                            const QByteArray& className,
                            const icomp::IRegistry& registry,
                            const Addresses& composedAddresses,
                            const Addresses& realAddresses,
                            QTextStream& stream) const;
       bool WriteDependencies(
                            const Addresses& composedAddresses,
                            const Addresses& realAddresses,
                            bool singleLine,
                            QTextStream& stream) const;
       bool WriteRegistryInfo(
                            const icomp::IRegistry& registry,
                            const QByteArray& registryCallPrefix,
                            QTextStream& stream) const;
       bool WriteComponentInfo(
                            const icomp::IRegistry& registry,
                            const QByteArray& registryCallPrefix,
                            const QByteArray& componentId,
                            const icomp::IRegistry::ElementInfo& componentInfo,
                            QTextStream& stream) const;
       bool WriteAttribute(
                            const QByteArray& attributeId,
                            const QByteArray& componentId,
                            const QByteArray& attributeName,
                            const iser::IObject& attribute,
                            QTextStream& stream) const;
 
       bool WriteRegistryTranslation(
                            const icomp::IRegistry& registry,
                            bool& translationFound,
                            QTextStream& stream) const;
       bool WritePackagesTranslation(
                            int level,
                            bool& translationFound,
                            QTextStream& stream) const;
 
       bool WriteComponentTranslation(
                            const QByteArray& componentId,
                            const icomp::IRegistry::ElementInfo& componentInfo,
                            bool& translationFound,
                            QTextStream& stream) const;
 
       bool WriteRegistryClassDeclaration(
                            const QByteArray& baseClassName,
                            const QByteArray& registryClassName,
                            const icomp::IRegistry& registry,
                            QTextStream& stream) const;
       bool WriteRegistryClassBody(
                            const QByteArray& baseClassName,
                            const QByteArray& registryClassName,
                            const icomp::IRegistry& registry,
                            QTextStream& stream) const;
       bool WriteDeserializingCode(const iser::ISerializable& object, QTextStream& stream) const;
 
       bool GetAttributeValue(
                            const iser::ISerializable& attribute,
                            QByteArray& valueString,
                            QByteArray& typeName) const;
       bool GetMultiAttributeValue(
                            const iser::ISerializable& attribute,
                            QList<QByteArray>& valueStrings,
                            QByteArray& typeName) const;
 
       bool NextLine(QTextStream& stream) const;
       int ChangeIndent(int difference) const;
 
       bool ExtractInfoFromFile(const QString& filePath, QByteArray& className, QString& baseFilePath) const;
 
       QByteArray GetPackageName(const QByteArray& packageId) const;
 
       QByteArray GetStringLiteral(const QString& text) const;
       QByteArray GetIdValueLiteral(const QByteArray& text) const;
       QByteArray GetValidIdentifier(const QByteArray& identifier) const;
 
private:
       I_REF(icomp::IPackagesManager, m_packagesManagerCompPtr);
       I_REF(icomp::IExtPackagesManager, m_extPackagesManagerCompPtr);
       I_REF(icomp::IRegistriesManager, m_registriesManagerCompPtr);
       I_ATTR(int, m_workingModeAttrPtr);
       I_ATTR(int, m_translationLevelAttrPtr);
       I_ATTR(bool, m_useBinaryCodeAttrPtr);
       I_ATTR(QString, m_depfilePathAttrPtr);
 
       mutable int m_indentCount;
};
 
 
} // namespace ipackage