Differential D20535 Diff 57079 src/core/machineinfo.cpp

Changeset View

Standalone View

View Options

src/core/machineinfo.cpp

  • This file was added.
1​/* AtCore
2​ Copyright (C) <2019>
3​
4​ Authors:
5​ Chris Rizzitello <rizzitello@kde.org>
6​
7​ This library is free software; you can redistribute it and/or
8​ modify it under the terms of the GNU Lesser General Public
9​ License as published by the Free Software Foundation; either
10​ version 2.1 of the License, or (at your option) version 3, or any
11​ later version accepted by the membership of KDE e.V. (or its
12​ successor approved by the membership of KDE e.V.), which shall
13​ act as a proxy defined in Section 6 of version 3 of the license.
14​
15​ This library is distributed in the hope that it will be useful,
16​ but WITHOUT ANY WARRANTY; without even the implied warranty of
17​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18​ Lesser General Public License for more details.
19​
20​ You should have received a copy of the GNU Lesser General Public
21​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
22​*/
23​
24​#include "machineinfo.h"
25​
26​#include <QCoreApplication>
27​
28​const QMap<MachineInfo::KEY, MachineInfo::keyInfo> MachineInfo::decoderMap = {
29​ {KEY::NAME, {QStringLiteral("Name"), QStringLiteral("ProfileName")}},
30​ {KEY::BAUDRATE, {QStringLiteral("bps"), 115200}},
31​ {KEY::FIRMWARE, {QStringLiteral("firmware"), QStringLiteral("Auto-Detect")}},
32​ {KEY::MAXBEDTEMP, {QStringLiteral("maximumTemperatureBed"), 0}},
33​ {KEY::MAXEXTTEMP, {QStringLiteral("maximumTemperatureExtruder"), 0}},
patrickelectricUnsubmitted
Done

Use {foo}, to create a single indentation

patrickelectric: Use `{foo},` to create a single indentation
34​ {KEY::POSTPAUSE, {QStringLiteral("postPause"), QString()}},
35​ {KEY::ISCARTESIAN, {QStringLiteral("isCartesian"), false}},
36​ {KEY::XMAX, {QStringLiteral("dimensionX"), 200}},
37​ {KEY::YMAX, {QStringLiteral("dimensionY"), 200}},
38​ {KEY::ZMAX, {QStringLiteral("dimensionZ"), 180}},
39​ {KEY::AUTOTEMPREPORT, {QStringLiteral("autoReportTemp"), false}}
40​};
41​
42​const MachineInfo &MachineInfo::getInstance()
43​{
44​ static MachineInfo m;
45​ return m;
46​}
patrickelectricUnsubmitted
Done

This should be a pointer to be accessible in qml;

patrickelectric: This should be a pointer to be accessible in qml;
rizzitelloAuthorUnsubmitted
Done

I was thinking it would be used like this in the main cpp file

qmlEngine.rootContext()->setContextProperty("machineInfo", MachineInfo::getInstance());
rizzitello: I was thinking it would be used like this in the main cpp file qmlEngine.rootContext()…
patrickelectricUnsubmitted
Done

you just need to register as a singleton, please use a pointer.
google for qmlregistersingletontype

patrickelectric: you just need to register as a singleton, please use a pointer. google for…
patrickelectricUnsubmitted
Done

You should return a pointer, but you don't need to create the object in the heap.

static MachineInfo m;
return &m;

Do not forget to set the ownership to cpp

patrickelectric: You should return a pointer, but you don't need to create the object in the heap. ```…
47​
48​MachineInfo::MachineInfo(QObject *parent) :
49​ QObject(parent)
50​ , m_settings(new QSettings(QSettings::IniFormat, QSettings::UserScope, QStringLiteral("atcore"), QStringLiteral("profiles"), this))
51​{
52​}
53​
54​QVariantMap MachineInfo::readProfile(const QString &profileName) const
55​{
56​ m_settings->beginGroup(profileName);
57​ QVariantMap data{
58​ {decoderMap[KEY::NAME].name, m_settings->group()},
patrickelectricUnsubmitted
Done

Why not a QMap<MachineInfo::KEY, QPair<QString, QVariant>> ?

patrickelectric: Why not a QMap<MachineInfo::KEY, QPair<QString, QVariant>> ?
rizzitelloAuthorUnsubmitted
Not Done

made a small struct with keyString and defaultValue Instaed but a similar idea.

rizzitello: made a small struct with keyString and defaultValue Instaed but a similar idea.
patrickelectricUnsubmitted
Done

is it possible to do this population with a for loop ?

patrickelectric: is it possible to do this population with a for loop ?
59​ {decoderMap[KEY::BAUDRATE].name, m_settings->value(decoderMap[KEY::BAUDRATE].name, decoderMap[KEY::BAUDRATE].defaultValue)},
60​ {decoderMap[KEY::MAXBEDTEMP].name, m_settings->value(decoderMap[KEY::MAXBEDTEMP].name, decoderMap[KEY::MAXBEDTEMP].defaultValue)},
61​ {decoderMap[KEY::MAXEXTTEMP].name, m_settings->value(decoderMap[KEY::MAXEXTTEMP].name, decoderMap[KEY::MAXEXTTEMP].defaultValue)},
62​ {decoderMap[KEY::FIRMWARE].name, m_settings->value(decoderMap[KEY::FIRMWARE].name, decoderMap[KEY::FIRMWARE].defaultValue)},
63​ {decoderMap[KEY::POSTPAUSE].name, m_settings->value(decoderMap[KEY::POSTPAUSE].name, decoderMap[KEY::POSTPAUSE].defaultValue)},
64​ {decoderMap[KEY::ISCARTESIAN].name, m_settings->value(decoderMap[KEY::ISCARTESIAN].name, decoderMap[KEY::ISCARTESIAN].defaultValue)},
65​ {decoderMap[KEY::XMAX].name, m_settings->value(decoderMap[KEY::XMAX].name, decoderMap[KEY::XMAX].defaultValue)},
patrickelectricUnsubmitted
Done

This values should be somewhere else no in the middle of the code. We should create a const standard profile in the class.

patrickelectric: This values should be somewhere else no in the middle of the code. We should create a const…
66​ {decoderMap[KEY::YMAX].name, m_settings->value(decoderMap[KEY::YMAX].name, decoderMap[KEY::YMAX].defaultValue)},
67​ {decoderMap[KEY::ZMAX].name, m_settings->value(decoderMap[KEY::ZMAX].name, decoderMap[KEY::ZMAX].defaultValue)},
68​ {decoderMap[KEY::AUTOTEMPREPORT].name, m_settings->value(decoderMap[KEY::AUTOTEMPREPORT].name, decoderMap[KEY::AUTOTEMPREPORT].defaultValue)}
patrickelectricUnsubmitted
Done

this is not necessary, you just need to save the settings inside a profiles configuration list.

patrickelectric: this is not necessary, you just need to save the settings inside a profiles configuration list.
69​ };
patrickelectricUnsubmitted
Not Done

does not need to be a pointer.

patrickelectric: does not need to be a pointer.
70​ m_settings->endGroup();
71​ return data;
72​}
73​
74​QVariant MachineInfo::readKey(const QString &profileName, MachineInfo::KEY key) const
75​{
76​ return key == KEY::NAME ? profileName.isEmpty() ? decoderMap[key].defaultValue : profileName : m_settings->value(QStringLiteral("%1/%2").arg(profileName, decoderMap[key].name), decoderMap[key].defaultValue);
patrickelectricUnsubmitted
Done

This line is huge.

patrickelectric: This line is huge.
77​}
78​
79​bool MachineInfo::storeKey(const QString &profileName, const MachineInfo::KEY key, const QVariant &value) const
80​{
81​ if (!profileNames().contains(profileName)) {
82​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
83​ }
84​
85​ if (readKey(profileName, key) == value) {
86​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
rizzitelloAuthorUnsubmitted
Done

This is triggered a bunch of times. You see it with the profile manager If your starting profile shares any values with what the defaults are set to one warning per instance of that same if you change between profiles and they any profile data in common you will get more of these in the log.

rizzitello: This is triggered a bunch of times. You see it with the profile manager If your starting…
87​ }
88​
89​ if (key == KEY::NAME) {
90​ //copyProfile emits profilesChanged
91​ return copyProfile(profileName, value.toString(), true);
92​ }
93​
94​ m_settings->beginGroup(profileName);
95​ m_settings->setValue(decoderMap[key].name, value);
96​ m_settings->endGroup();
97​ emit profilesChanged();
98​ return true;
99​}
100​
101​bool MachineInfo::copyProfile(const QString &srcProfile, const QString &destProfile, bool rmSrc) const
patrickelectricUnsubmitted
Done

if does not contain return false, avoid indentation.

patrickelectric: if does not contain return false, avoid indentation.
102​{
103​ if (srcProfile.isEmpty() || destProfile.isEmpty()) {
104​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
105​ }
106​
107​ if (!profileNames().contains(srcProfile)) {
108​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
109​ }
110​
111​ if (srcProfile == destProfile) {
112​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
113​ }
114​
115​ QVariantMap newProfile = readProfile(srcProfile);
116​ m_settings->beginGroup(destProfile);
117​ m_settings->setValue(decoderMap[KEY::FIRMWARE].name, newProfile[decoderMap[KEY::FIRMWARE].name]);
118​ m_settings->setValue(decoderMap[KEY::BAUDRATE].name, newProfile[decoderMap[KEY::BAUDRATE].name]);
119​ m_settings->setValue(decoderMap[KEY::MAXBEDTEMP].name, newProfile[decoderMap[KEY::MAXBEDTEMP].name]);
120​ m_settings->setValue(decoderMap[KEY::MAXEXTTEMP].name, newProfile[decoderMap[KEY::MAXEXTTEMP].name]);
121​ m_settings->setValue(decoderMap[KEY::POSTPAUSE].name, newProfile[decoderMap[KEY::POSTPAUSE].name]);
122​ m_settings->setValue(decoderMap[KEY::ISCARTESIAN].name, newProfile[decoderMap[KEY::ISCARTESIAN].name]);
123​ m_settings->setValue(decoderMap[KEY::XMAX].name, newProfile[decoderMap[KEY::XMAX].name]);
124​ m_settings->setValue(decoderMap[KEY::YMAX].name, newProfile[decoderMap[KEY::YMAX].name]);
125​ m_settings->setValue(decoderMap[KEY::ZMAX].name, newProfile[decoderMap[KEY::ZMAX].name]);
126​ m_settings->setValue(decoderMap[KEY::AUTOTEMPREPORT].name, newProfile[decoderMap[KEY::AUTOTEMPREPORT].name]);
127​ m_settings->endGroup();
128​
129​ if (rmSrc) {
130​ removeProfile(srcProfile);
131​ //removeProfile emits profilesChanged
patrickelectricUnsubmitted
Done

can you return childGRoups directly ? why m_settings is a pointer ?

patrickelectric: can you return childGRoups directly ? why m_settings is a pointer ?
132​ } else {
133​ emit profilesChanged();
134​ }
135​ return true;
136​}
137​
138​bool MachineInfo::removeProfile(const QString &profileName) const
139​{
140​ if (!profileNames().contains(profileName)) {
141​ return false;
patrickelectricUnsubmitted
Done

qCWarning missing

patrickelectric: qCWarning missing
142​ }
143​ m_settings->beginGroup(profileName);
144​ m_settings->remove(QString());
145​ m_settings->endGroup();
146​ emit profilesChanged();
147​ return true;
148​}
149​
150​void MachineInfo::storeProfile(const QMap<MachineInfo::KEY, QVariant> &profile) const
151​{
152​ m_settings->beginGroup(profile[KEY::NAME].toString());
153​ m_settings->setValue(decoderMap[KEY::FIRMWARE].name, profile[KEY::FIRMWARE]);
154​ m_settings->setValue(decoderMap[KEY::BAUDRATE].name, profile[KEY::BAUDRATE]);
155​ m_settings->setValue(decoderMap[KEY::MAXBEDTEMP].name, profile[KEY::MAXBEDTEMP]);
156​ m_settings->setValue(decoderMap[KEY::MAXEXTTEMP].name, profile[KEY::MAXEXTTEMP]);
157​ m_settings->setValue(decoderMap[KEY::POSTPAUSE].name, profile[KEY::POSTPAUSE]);
158​ m_settings->setValue(decoderMap[KEY::ISCARTESIAN].name, profile[KEY::ISCARTESIAN]);
159​ m_settings->setValue(decoderMap[KEY::XMAX].name, profile[KEY::XMAX]);
160​ m_settings->setValue(decoderMap[KEY::YMAX].name, profile[KEY::YMAX]);
161​ m_settings->setValue(decoderMap[KEY::ZMAX].name, profile[KEY::ZMAX]);
162​ m_settings->setValue(decoderMap[KEY::AUTOTEMPREPORT].name, profile[KEY::AUTOTEMPREPORT]);
patrickelectricUnsubmitted
Done

is it possible to do that with a for ?

patrickelectric: is it possible to do that with a for ?
163​ m_settings->endGroup();
164​ emit profilesChanged();
165​}
166​
167​QStringList MachineInfo::profileNames() const
168​{
169​ return m_settings->childGroups();
170​}
171​