Skip to content

Commit fa770f5

Browse files
committed
Rename constant fields in ImportOds for consistency and clarity.
1 parent cb3c690 commit fa770f5

File tree

2 files changed

+53
-56
lines changed

2 files changed

+53
-56
lines changed

include/eible/ImportOds.h

+23-23
Original file line numberDiff line numberDiff line change
@@ -78,28 +78,28 @@ class EIBLE_EXPORT ImportOds : public ImportSpreadsheet
7878

7979
std::optional<QStringList> sheetNames_{std::nullopt};
8080

81-
const QString TABLE_TAG{QStringLiteral("table")};
82-
const QString TABLE_ROW_TAG{QStringLiteral("table-row")};
83-
const QString TABLE_CELL_TAG{QStringLiteral("table-cell")};
84-
const QString OFFICE_VALUE_TYPE_TAG{QStringLiteral("office:value-type")};
85-
const QString COLUMNS_REPEATED_TAG{
81+
const QString tableTag_{QStringLiteral("table")};
82+
const QString tableRowTag_{QStringLiteral("table-row")};
83+
const QString tableCellTag_{QStringLiteral("table-cell")};
84+
const QString officeValueTypeTag_{QStringLiteral("office:value-type")};
85+
const QString columnsRepeatedTag_{
8686
QStringLiteral("table:number-columns-repeated")};
87-
const QString STRING_TAG{QStringLiteral("string")};
88-
const QString DATE_TAG{QStringLiteral("date")};
89-
const QString FLOAT_TAG{QStringLiteral("float")};
90-
const QString PERCENTAGE_TAG{QStringLiteral("percentage")};
91-
const QString CURRENCY_TAG{QStringLiteral("currency")};
92-
const QString TIME_TAG{QStringLiteral("time")};
93-
const QString P_TAG{QStringLiteral("p")};
94-
const QString OFFICE_DATE_VALUE_TAG{QStringLiteral("office:date-value")};
95-
const QString OFFICE_VALUE_TAG{QStringLiteral("office:value")};
96-
const QString DATE_FORMAT{QStringLiteral("yyyy-MM-dd")};
97-
const QString TABLE_QUALIFIED_NAME{QStringLiteral("table:table")};
98-
const QString TABLE_NAME_TAG{QStringLiteral("table:name")};
99-
100-
const QStringList RECOCNIZED_COLUMN_TYPES{STRING_TAG, DATE_TAG,
101-
FLOAT_TAG, PERCENTAGE_TAG,
102-
CURRENCY_TAG, TIME_TAG};
103-
104-
const int ODS_STRING_DATE_LENGTH{10};
87+
const QString stringTag_{QStringLiteral("string")};
88+
const QString dateTag_{QStringLiteral("date")};
89+
const QString floatTag_{QStringLiteral("float")};
90+
const QString percentageTag_{QStringLiteral("percentage")};
91+
const QString currencyTag_{QStringLiteral("currency")};
92+
const QString timeTag_{QStringLiteral("time")};
93+
const QString pTag_{QStringLiteral("p")};
94+
const QString officeDateValueTag_{QStringLiteral("office:date-value")};
95+
const QString officeValueTag_{QStringLiteral("office:value")};
96+
const QString dateFormat_{QStringLiteral("yyyy-MM-dd")};
97+
const QString tableQualifiedName_{QStringLiteral("table:table")};
98+
const QString tableNameTag_{QStringLiteral("table:name")};
99+
100+
const QStringList recognizedColumnTypes_{stringTag_, dateTag_,
101+
floatTag_, percentageTag_,
102+
currencyTag_, timeTag_};
103+
104+
const int odsStringDateLength_{10};
105105
};

src/ImportOds.cpp

+30-33
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ std::pair<bool, QVector<QVector<QVariant>>> ImportOds::getLimitedData(
8585
int rowCounter{0};
8686
bool rowEmpty{true};
8787
int lastEmittedPercent{0};
88-
while ((!reader.atEnd()) && (reader.name() != TABLE_TAG) &&
88+
while ((!reader.atEnd()) && (reader.name() != tableTag_) &&
8989
(rowCounter < rowLimit))
9090
{
9191
if (isRowStart(reader))
@@ -201,20 +201,20 @@ std::pair<bool, QStringList> ImportOds::retrieveColumnNames(
201201
reader.setDevice(&quaZipFile);
202202
skipToSheet(reader, sheetName);
203203

204-
while ((!reader.atEnd()) && (reader.name() != TABLE_ROW_TAG))
204+
while ((!reader.atEnd()) && (reader.name() != tableRowTag_))
205205
reader.readNext();
206206
reader.readNext();
207207

208208
QXmlStreamReader::TokenType lastToken{reader.tokenType()};
209209
QStringList columnNames;
210210

211-
while ((!reader.atEnd()) && (reader.name() != TABLE_ROW_TAG))
211+
while ((!reader.atEnd()) && (reader.name() != tableRowTag_))
212212
{
213213
if (isCellStart(reader) &&
214214
(getColumnRepeatCount(reader.attributes()) > 1))
215215
return {true, columnNames};
216216

217-
if ((reader.name().toString() == P_TAG) && reader.isStartElement())
217+
if ((reader.name().toString() == pTag_) && reader.isStartElement())
218218
{
219219
while (reader.tokenType() != QXmlStreamReader::Characters)
220220
reader.readNext();
@@ -260,7 +260,7 @@ ImportOds::retrieveRowCountAndColumnTypes(const QString& sheetName)
260260
int rowCounter{0};
261261
bool rowEmpty{true};
262262

263-
while ((!reader.atEnd()) && (reader.name() != TABLE_TAG))
263+
while ((!reader.atEnd()) && (reader.name() != tableTag_))
264264
{
265265
if (isRowStart(reader))
266266
column = NOT_SET_COLUMN;
@@ -270,7 +270,7 @@ ImportOds::retrieveRowCountAndColumnTypes(const QString& sheetName)
270270
++column;
271271
const QXmlStreamAttributes attributes{reader.attributes()};
272272
const QString xmlColTypeValue{
273-
attributes.value(OFFICE_VALUE_TYPE_TAG).toString()};
273+
attributes.value(officeValueTypeTag_).toString()};
274274
const int repeats{getColumnRepeatCount(attributes)};
275275
if (isRecognizedColumnType(attributes))
276276
{
@@ -305,7 +305,7 @@ void ImportOds::moveToSecondRow(const QString& sheetName,
305305

306306
bool secondRow{false};
307307
while ((!reader.atEnd()) &&
308-
(!((reader.qualifiedName() == TABLE_QUALIFIED_NAME) &&
308+
(!((reader.qualifiedName() == tableQualifiedName_) &&
309309
reader.isEndElement())))
310310
{
311311
if (isRowStart(reader))
@@ -324,9 +324,9 @@ void ImportOds::skipToSheet(QXmlStreamReader& reader,
324324
{
325325
while (!reader.atEnd())
326326
{
327-
if (reader.qualifiedName() == TABLE_QUALIFIED_NAME)
327+
if (reader.qualifiedName() == tableQualifiedName_)
328328
{
329-
if (reader.attributes().value(TABLE_NAME_TAG) != sheetName)
329+
if (reader.attributes().value(tableNameTag_) != sheetName)
330330
reader.skipCurrentElement();
331331
else
332332
return;
@@ -338,61 +338,58 @@ void ImportOds::skipToSheet(QXmlStreamReader& reader,
338338
bool ImportOds::isRecognizedColumnType(
339339
const QXmlStreamAttributes& attributes) const
340340
{
341-
const QString columnType{
342-
attributes.value(OFFICE_VALUE_TYPE_TAG).toString()};
343-
return RECOCNIZED_COLUMN_TYPES.contains(columnType);
341+
const QString columnType{attributes.value(officeValueTypeTag_).toString()};
342+
return recognizedColumnTypes_.contains(columnType);
344343
}
345344

346345
int ImportOds::getColumnRepeatCount(
347346
const QXmlStreamAttributes& attributes) const
348347
{
349-
const int repeats{
350-
attributes.value(COLUMNS_REPEATED_TAG).toString().toInt()};
348+
const int repeats{attributes.value(columnsRepeatedTag_).toString().toInt()};
351349
return std::max(1, repeats);
352350
}
353351

354352
bool ImportOds::isRowStart(const QXmlStreamReader& reader) const
355353
{
356-
return (reader.name() == TABLE_ROW_TAG) && reader.isStartElement();
354+
return (reader.name() == tableRowTag_) && reader.isStartElement();
357355
}
358356

359357
bool ImportOds::isRowEnd(const QXmlStreamReader& reader) const
360358
{
361-
return (reader.name() == TABLE_ROW_TAG) && reader.isEndElement();
359+
return (reader.name() == tableRowTag_) && reader.isEndElement();
362360
}
363361

364362
bool ImportOds::isCellStart(const QXmlStreamReader& reader) const
365363
{
366-
return (reader.name() == TABLE_CELL_TAG) && reader.isStartElement();
364+
return (reader.name() == tableCellTag_) && reader.isStartElement();
367365
}
368366

369367
bool ImportOds::isCellEnd(const QXmlStreamReader& reader) const
370368
{
371-
return (reader.name().toString() == TABLE_CELL_TAG) &&
372-
reader.isEndElement();
369+
return (reader.name().toString() == tableCellTag_) && reader.isEndElement();
373370
}
374371

375372
ColumnType ImportOds::recognizeColumnType(ColumnType currentType,
376373
const QString& xmlColTypeValue) const
377374
{
378-
if (xmlColTypeValue == STRING_TAG)
375+
if (xmlColTypeValue == stringTag_)
379376
{
380377
if (currentType == ColumnType::UNKNOWN)
381378
return ColumnType::STRING;
382379
if (currentType != ColumnType::STRING)
383380
return ColumnType::STRING;
384381
}
385382

386-
if (xmlColTypeValue == DATE_TAG)
383+
if (xmlColTypeValue == dateTag_)
387384
{
388385
if (currentType == ColumnType::UNKNOWN)
389386
return ColumnType::DATE;
390387
if (currentType != ColumnType::DATE)
391388
return ColumnType::STRING;
392389
}
393390

394-
if ((xmlColTypeValue == FLOAT_TAG) || (xmlColTypeValue == PERCENTAGE_TAG) ||
395-
(xmlColTypeValue == CURRENCY_TAG) || (xmlColTypeValue == TIME_TAG))
391+
if ((xmlColTypeValue == floatTag_) || (xmlColTypeValue == percentageTag_) ||
392+
(xmlColTypeValue == currencyTag_) || (xmlColTypeValue == timeTag_))
396393
{
397394
if (currentType == ColumnType::UNKNOWN)
398395
return ColumnType::NUMBER;
@@ -407,19 +404,19 @@ QVariant ImportOds::retrieveValueFromStringColumn(
407404
QXmlStreamReader& reader) const
408405
{
409406
const QString xmlColTypeValue{
410-
reader.attributes().value(OFFICE_VALUE_TYPE_TAG).toString()};
407+
reader.attributes().value(officeValueTypeTag_).toString()};
411408
const QString emptyString(QString::fromLatin1(""));
412409
const QString currentDateValue{
413-
reader.attributes().value(OFFICE_DATE_VALUE_TAG).toString()};
410+
reader.attributes().value(officeDateValueTag_).toString()};
414411

415-
while ((!reader.atEnd()) && (reader.name() != P_TAG))
412+
while ((!reader.atEnd()) && (reader.name() != pTag_))
416413
reader.readNext();
417414

418415
while ((reader.tokenType() != QXmlStreamReader::Characters) &&
419-
(reader.name() != TABLE_CELL_TAG))
416+
(reader.name() != tableCellTag_))
420417
reader.readNext();
421418

422-
if (xmlColTypeValue == DATE_TAG)
419+
if (xmlColTypeValue == dateTag_)
423420
return {currentDateValue};
424421

425422
const QStringView stringView{reader.text()};
@@ -437,18 +434,18 @@ QVariant ImportOds::retrieveValueFromField(QXmlStreamReader& reader,
437434
return retrieveValueFromStringColumn(reader);
438435

439436
if (columnType == ColumnType::NUMBER)
440-
return {reader.attributes().value(OFFICE_VALUE_TAG).toDouble()};
437+
return {reader.attributes().value(officeValueTag_).toDouble()};
441438

442439
QString dateValue{
443-
reader.attributes().value(OFFICE_DATE_VALUE_TAG).toString()};
444-
dateValue.chop(dateValue.size() - ODS_STRING_DATE_LENGTH);
445-
return QDate::fromString(dateValue, DATE_FORMAT);
440+
reader.attributes().value(officeDateValueTag_).toString()};
441+
dateValue.chop(dateValue.size() - odsStringDateLength_);
442+
return QDate::fromString(dateValue, dateFormat_);
446443
}
447444

448445
bool ImportOds::isOfficeValueTagEmpty(const QXmlStreamReader& reader) const
449446
{
450447
const QString xmlColTypeValue{
451-
reader.attributes().value(OFFICE_VALUE_TYPE_TAG).toString()};
448+
reader.attributes().value(officeValueTypeTag_).toString()};
452449
return xmlColTypeValue.isEmpty();
453450
}
454451

0 commit comments

Comments
 (0)