Skip to content

Commit 31fadd1

Browse files
m-kuhnm-kuhn
authored
Merge pull request #7692 from m-kuhn/arrayRep
Adjust representation of arrays and maps in expressions
2 parents a5a6f00 + ec4483a commit 31fadd1

23 files changed

+72
-57
lines changed

‎resources/function_help/json/array

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
{"arg":"value1", "syntaxOnly": true},
88
{"arg":"value2", "syntaxOnly": true},
99
{"arg":"value", "descOnly": true, "description":"a value"}],
10-
"examples": [ { "expression":"array(2,10)", "returns":"array: 2, 10"}
10+
"examples": [ { "expression":"array(2,10)", "returns":"[ 2, 10 ]"}
1111
]
1212
}

‎resources/function_help/json/array_append

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"description": "Returns an array with the given value added at the end.",
55
"arguments": [ {"arg":"array","description":"an array"},
66
{"arg":"value","description":"the value to add"}],
7-
"examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"array: 1,2,3,4"}]
7+
"examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"[ 1, 2, 3, 4 ]"}]
88
}

‎resources/function_help/json/array_cat

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
{"arg":"array1", "syntaxOnly": true},
88
{"arg":"array2", "syntaxOnly": true},
99
{"arg":"array", "descOnly": true, "description":"an array"}],
10-
"examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"array: 1,2,2,3"}
10+
"examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"[ 1, 2, 2, 3 ]"}
1111
]
1212
}

‎resources/function_help/json/array_distinct

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
"description": "Returns an array containing distinct values of the given array.",
55
"arguments": [
66
{"arg":"array","description":"an array"}],
7-
"examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"array: 1,2,3"}
7+
"examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"[ 1, 2, 3 ]"}
88
]
99
}

‎resources/function_help/json/array_foreach

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{"arg":"expression","description":"an expression to evaluate on each item. The variable `@element` will be replaced by the current value."}
88
],
99
"examples": [
10-
{ "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"array: 'A', 'B', 'C'"},
11-
{ "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"array: 11, 12, 13"}
10+
{ "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"[ 'A', 'B', 'C' ]"},
11+
{ "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"[ 11, 12, 13 ]"}
1212
]
1313
}

‎resources/function_help/json/array_insert

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"arguments": [ {"arg":"array","description":"an array"},
66
{"arg":"pos","description":"the position where to add (0 based)"},
77
{"arg":"value","description":"the value to add"}],
8-
"examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"array: 1,100,2,3"}]
8+
"examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"[ 1, 100, 2, 3 ]"}]
99
}

‎resources/function_help/json/array_prepend

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"description": "Returns an array with the given value added at the beginning.",
55
"arguments": [ {"arg":"array","description":"an array"},
66
{"arg":"value","description":"the value to add"}],
7-
"examples": [ { "expression":"array_prepend(array(1,2,3),0)", "returns":"array: 0,1,2,3"}]
7+
"examples": [ { "expression":"array_prepend(array(1,2,3),0)", "returns":"[ 0, 1, 2, 3 ]"}]
88
}

‎resources/function_help/json/array_remove_all

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"description": "Returns an array with all the entries of the given value removed.",
55
"arguments": [ {"arg":"array","description":"an array"},
66
{"arg":"value","description":"the values to remove"}],
7-
"examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"array: 'a','c'"}]
7+
"examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"[ 'a', 'c' ]"}]
88
}

‎resources/function_help/json/array_remove_at

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"description": "Returns an array with the given index removed.",
55
"arguments": [ {"arg":"array","description":"an array"},
66
{"arg":"pos","description":"the position to remove (0 based)"}],
7-
"examples": [ { "expression":"array_remove_at(array(1,2,3),1)", "returns":"array: 1,3"}]
7+
"examples": [ { "expression":"array_remove_at(array(1,2,3),1)", "returns":"[ 1, 3 ]"}]
88
}

‎resources/function_help/json/array_reverse

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"type": "function",
44
"description": "Returns the given array with array values in reversed order.",
55
"arguments": [ {"arg":"array","description":"an array"} ],
6-
"examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"array: 10,0,4,2"}]
6+
"examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"[ 10, 0, 4, 2 ]"}]
77
}

‎resources/function_help/json/array_slice

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,35 @@
1717
],
1818
"examples": [{
1919
"expression": "array_slice(array(1,2,3,4,5),0,3)",
20-
"returns": "array: 1,2,3,4"
20+
"returns": "[ 1, 2, 3, 4 ]"
2121
},
2222
{
2323
"expression": "array_slice(array(1,2,3,4,5),0,-1)",
24-
"returns": "array: 1,2,3,4,5"
24+
"returns": "[ 1, 2, 3, 4, 5 ]"
2525
},
2626
{
2727
"expression": "array_slice(array(1,2,3,4,5),-5,-1)",
28-
"returns": "array: 1,2,3,4,5"
28+
"returns": "[ 1, 2, 3, 4, 5 ]"
2929
},
3030
{
3131
"expression": "array_slice(array(1,2,3,4,5),0,0)",
32-
"returns": "array: 1"
32+
"returns": "[ 1 ]"
3333
},
3434
{
3535
"expression": "array_slice(array(1,2,3,4,5),-2,-1)",
36-
"returns": "array: 4,5"
36+
"returns": "[ 4, 5 ]"
3737
},
3838
{
3939
"expression": "array_slice(array(1,2,3,4,5),-1,-1)",
40-
"returns": "array: 5"
40+
"returns": "[ 5 ]"
4141
},
4242
{
4343
"expression": "array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),1,2)",
44-
"returns": "array: 'Valmiera','Chugiak'"
44+
"returns": "[ 'Valmiera', 'Chugiak' ]"
4545
},
4646
{
4747
"expression": "array_slice(array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),-2,-1)",
48-
"returns": "array: 'Chugiak','Brighton'"
48+
"returns": "[ 'Chugiak', 'Brighton' ]"
4949
}
5050
]
5151
}

‎resources/function_help/json/generate_series

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{"arg":"stop", "description":"value that ends the sequence once reached"},
88
{"arg":"step","optional":true,"default":"1","description":"value used as the increment between values"}
99
],
10-
"examples": [ { "expression":"generate_series('1,5)", "returns":"array: '1', '2', '3', '4', '5'"},
11-
{ "expression":"generate_series('5,1,-1)", "returns":"array: '5', '4', '3', '2', '1'"}
10+
"examples": [ { "expression":"generate_series('1,5)", "returns":"[ 1, 2, 3, 4, 5 ]"},
11+
{ "expression":"generate_series('5,1,-1)", "returns":"[ 5, 4, 3, 2, 1 ]"}
1212
]
1313
}

‎resources/function_help/json/map

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
{"arg":"value2", "syntaxOnly": true},
1111
{"arg":"key", "descOnly": true, "description":"a key (string)"},
1212
{"arg":"value", "descOnly": true, "description":"a value"}],
13-
"examples": [ { "expression":"map('1','one','2', 'two')", "returns":"map: 1: 'one', 2: 'two'"}
13+
"examples": [ { "expression":"map('1','one','2', 'two')", "returns":"{ '1': 'one', '2': 'two' }"}
1414
]
1515
}

‎resources/function_help/json/map_akeys

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"type": "function",
44
"description": "Returns all the keys of a map as an array.",
55
"arguments": [ {"arg":"map","description":"a map"}],
6-
"examples": [ { "expression":"map_akeys(map('1','one','2','two'))", "returns":"array: '1', '2'"}]
6+
"examples": [ { "expression":"map_akeys(map('1','one','2','two'))", "returns":"[ '1', '2' ]"}]
77
}

‎resources/function_help/json/map_avals

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"type": "function",
44
"description": "Returns all the values of a map as an array.",
55
"arguments": [ {"arg":"map","description":"a map"}],
6-
"examples": [ { "expression":"map_avals(map('1','one','2','two'))", "returns":"array: 'one', 'two'"}]
6+
"examples": [ { "expression":"map_avals(map('1','one','2','two'))", "returns":"[ 'one', 'two' ]"}]
77
}

‎resources/function_help/json/map_concat

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
{"arg":"map1", "syntaxOnly": true},
88
{"arg":"map2", "syntaxOnly": true},
99
{"arg":"map", "descOnly": true, "description":"a map"}],
10-
"examples": [ { "expression":"map_concat(map('1','one', '2','overridden'),map('2','two', '3','three'))", "returns":"map: 1: 'one, 2: 'two', 3: 'three'"}
10+
"examples": [ { "expression":"map_concat(map('1','one', '2','overridden'),map('2','two', '3','three'))", "returns":"{ '1': 'one, '2': 'two', '3': 'three' }"}
1111
]
1212
}

‎resources/function_help/json/map_delete

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"description": "Returns a map with the given key and its corresponding value deleted.",
55
"arguments": [ {"arg":"map","description":"a map"},
66
{"arg":"key","description":"the key to delete"}],
7-
"examples": [ { "expression":"map_delete(map('1','one','2','two'),'2')", "returns":"map: 1: 'one'"}]
7+
"examples": [ { "expression":"map_delete(map('1','one','2','two'),'2')", "returns":"{ '1': 'one' }"}]
88
}

‎resources/function_help/json/map_insert

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"arguments": [ {"arg":"map","description":"a map"},
66
{"arg":"key","description":"the key to add"},
77
{"arg":"value","description":"the value to add"}],
8-
"examples": [ { "expression":"map_insert(map('1','one'),'3','three')", "returns":"map: 1: 'one', 3: 'three'"}]
8+
"examples": [ { "expression":"map_insert(map('1','one'),'3','three')", "returns":"{ '1': 'one', '3': 'three' }"}]
99
}

‎resources/function_help/json/regexp_matches

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{"arg":"string", "description":"the string to capture groups from against the regular expression"},
77
{"arg":"regex","description":"the regular expression used to capture groups"},
88
{"arg":"empty_value","optional":true,"default":"''","description":"the optional string to use as replacement for empty (zero length) matches"}],
9-
"examples": [ { "expression":"regexp_matches('QGIS=>rocks','(.*)=>(.*)')", "returns":"array: 'QGIS', 'rocks'"},
10-
{ "expression":"regexp_matches('key=>','(.*)=>(.*)','empty value')", "returns":"array: 'key', 'empty value'"}
9+
"examples": [ { "expression":"regexp_matches('QGIS=>rocks','(.*)=>(.*)')", "returns":"[ 'QGIS', 'rocks' ]"},
10+
{ "expression":"regexp_matches('key=>','(.*)=>(.*)','empty value')", "returns":"[ 'key', 'empty value' ]"}
1111
]
1212
}

‎resources/function_help/json/string_to_array

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{"arg":"string", "description":"the input string"},
77
{"arg":"delimiter","optional":true,"default":"','","description":"the string delimiter used to split the input string"},
88
{"arg":"empty_value","optional":true,"default":"''","description":"the optional string to use as replacement for empty (zero length) matches"}],
9-
"examples": [ { "expression":"string_to_array('1,2,3',',')", "returns":"array: '1', '2', '3'"},
10-
{ "expression":"string_to_array('1,,3',',','0')", "returns":"array: '1', '0', '3'"}
9+
"examples": [ { "expression":"string_to_array('1,2,3',',')", "returns":"[ '1', '2', '3' ]"},
10+
{ "expression":"string_to_array('1,,3',',','0')", "returns":"[ '1', '0', '3' ]"}
1111
]
1212
}

‎src/core/expression/qgsexpression.cpp

+28-13
Original file line numberDiff line numberDiff line change
@@ -903,35 +903,50 @@ QString QgsExpression::formatPreviewString( const QVariant &value )
903903
}
904904
else if ( value.type() == QVariant::Map )
905905
{
906-
QString mapStr;
906+
QString mapStr = QStringLiteral( "{" );
907907
const QVariantMap map = value.toMap();
908+
QString separator;
908909
for ( QVariantMap::const_iterator it = map.constBegin(); it != map.constEnd(); ++it )
909910
{
910-
if ( !mapStr.isEmpty() ) mapStr.append( ", " );
911-
mapStr.append( it.key() ).append( ": " ).append( formatPreviewString( it.value() ) );
912-
if ( mapStr.length() > MAX_PREVIEW + 3 )
911+
mapStr.append( separator );
912+
if ( separator.isEmpty() )
913+
separator = QStringLiteral( "," );
914+
915+
mapStr.append( QStringLiteral( " '%1': %2" ).arg( it.key(), formatPreviewString( it.value() ) ) );
916+
if ( mapStr.length() > MAX_PREVIEW - 3 )
913917
{
914-
mapStr = QString( tr( "%1…" ) ).arg( mapStr.left( MAX_PREVIEW ) );
918+
mapStr = tr( "%1…" ).arg( mapStr.left( MAX_PREVIEW - 2 ) );
915919
break;
916920
}
917921
}
918-
return tr( "<i>&lt;map: %1&gt;</i>" ).arg( mapStr );
922+
if ( !map.empty() )
923+
mapStr += QStringLiteral( " " );
924+
mapStr += QStringLiteral( "}" );
925+
return mapStr;
919926
}
920927
else if ( value.type() == QVariant::List || value.type() == QVariant::StringList )
921928
{
922-
QString listStr;
929+
QString listStr = QStringLiteral( "[" );
923930
const QVariantList list = value.toList();
924-
for ( QVariantList::const_iterator it = list.constBegin(); it != list.constEnd(); ++it )
931+
QString separator;
932+
for ( const QVariant &arrayValue : list )
925933
{
926-
if ( !listStr.isEmpty() ) listStr.append( ", " );
927-
listStr.append( formatPreviewString( *it ) );
928-
if ( listStr.length() > MAX_PREVIEW + 3 )
934+
listStr.append( separator );
935+
if ( separator.isEmpty() )
936+
separator = QStringLiteral( "," );
937+
938+
listStr.append( " " );
939+
listStr.append( formatPreviewString( arrayValue ) );
940+
if ( listStr.length() > MAX_PREVIEW - 3 )
929941
{
930-
listStr = QString( tr( "%1…" ) ).arg( listStr.left( MAX_PREVIEW ) );
942+
listStr = QString( tr( "%1…" ) ).arg( listStr.left( MAX_PREVIEW - 2 ) );
931943
break;
932944
}
933945
}
934-
return tr( "<i>&lt;array: %1&gt;</i>" ).arg( listStr );
946+
if ( !list.empty() )
947+
listStr += QStringLiteral( " " );
948+
listStr += QStringLiteral( "]" );
949+
return listStr;
935950
}
936951
else
937952
{

‎src/gui/qgsexpressionbuilderwidget.cpp

+7-7
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ void QgsExpressionBuilderWidget::btnNewFile_pressed()
279279
bool ok;
280280
QString text = QInputDialog::getText( this, tr( "Enter new file name" ),
281281
tr( "File name:" ), QLineEdit::Normal,
282-
QLatin1String( "" ), &ok );
282+
QString(), &ok );
283283
if ( ok && !text.isEmpty() )
284284
{
285285
newFunctionFile( text );
@@ -348,7 +348,7 @@ void QgsExpressionBuilderWidget::loadFieldNames( const QgsFields &fields )
348348
{
349349
QString fieldName = fields.at( i ).name();
350350
fieldNames << fieldName;
351-
registerItem( QStringLiteral( "Fields and Values" ), fieldName, " \"" + fieldName + "\" ", QLatin1String( "" ), QgsExpressionItem::Field, false, i );
351+
registerItem( QStringLiteral( "Fields and Values" ), fieldName, " \"" + fieldName + "\" ", QString(), QgsExpressionItem::Field, false, i );
352352
}
353353
// highlighter->addFields( fieldNames );
354354
}
@@ -426,7 +426,7 @@ void QgsExpressionBuilderWidget::registerItem( const QString &group,
426426
else
427427
{
428428
// If the group doesn't exist yet we make it first.
429-
QgsExpressionItem *newgroupNode = new QgsExpressionItem( QgsExpression::group( group ), QLatin1String( "" ), QgsExpressionItem::Header );
429+
QgsExpressionItem *newgroupNode = new QgsExpressionItem( QgsExpression::group( group ), QString(), QgsExpressionItem::Header );
430430
newgroupNode->setData( group, Qt::UserRole );
431431
//Recent group should always be last group
432432
newgroupNode->setData( group.startsWith( QLatin1String( "Recent (" ) ) ? 2 : 1, QgsExpressionItem::CUSTOM_SORT_ROLE );
@@ -628,9 +628,9 @@ void QgsExpressionBuilderWidget::txtExpressionString_textChanged()
628628
if ( text.isEmpty() )
629629
{
630630
lblPreview->clear();
631-
lblPreview->setStyleSheet( QLatin1String( "" ) );
632-
txtExpressionString->setToolTip( QLatin1String( "" ) );
633-
lblPreview->setToolTip( QLatin1String( "" ) );
631+
lblPreview->setStyleSheet( QString() );
632+
txtExpressionString->setToolTip( QString() );
633+
lblPreview->setToolTip( QString() );
634634
emit expressionParsed( false );
635635
setParserError( true );
636636
setEvalError( true );
@@ -1064,7 +1064,7 @@ QString QgsExpressionBuilderWidget::helpStylesheet() const
10641064
QString QgsExpressionBuilderWidget::loadFunctionHelp( QgsExpressionItem *expressionItem )
10651065
{
10661066
if ( !expressionItem )
1067-
return QLatin1String( "" );
1067+
return QString();
10681068

10691069
QString helpContents = expressionItem->getHelpText();
10701070

‎tests/src/core/testqgsexpression.cpp

+6-6
Original file line numberDiff line numberDiff line change
@@ -3114,24 +3114,24 @@ class TestQgsExpression: public QObject
31143114

31153115
void test_formatPreviewString()
31163116
{
3117-
QCOMPARE( QgsExpression::formatPreviewString( QVariant( "hello" ) ), QString( "'hello'" ) );
3118-
QCOMPARE( QgsExpression::formatPreviewString( QVariant( QVariantMap() ) ), QString( "<i>&lt;map: &gt;</i>" ) );
3117+
QCOMPARE( QgsExpression::formatPreviewString( QVariant( "hello" ) ), QStringLiteral( "'hello'" ) );
3118+
QCOMPARE( QgsExpression::formatPreviewString( QVariant( QVariantMap() ) ), QStringLiteral( "{}" ) );
31193119

31203120
QVariantMap map;
31213121
map[QStringLiteral( "1" )] = "One";
31223122
map[QStringLiteral( "2" )] = "Two";
3123-
QCOMPARE( QgsExpression::formatPreviewString( QVariant( map ) ), QString( "<i>&lt;map: 1: 'One', 2: 'Two'&gt;</i>" ) );
3123+
QCOMPARE( QgsExpression::formatPreviewString( QVariant( map ) ), QStringLiteral( "{ '1': 'One', '2': 'Two' }" ) );
31243124
map[QStringLiteral( "3" )] = "A very long string that is going to be truncated";
3125-
QCOMPARE( QgsExpression::formatPreviewString( QVariant( map ) ), QString( "<i>&lt;map: 1: 'One', 2: 'Two', 3: 'A very long string that is going to …&gt;</i>" ) );
3125+
QCOMPARE( QgsExpression::formatPreviewString( QVariant( map ) ), QStringLiteral( "{ '1': 'One', '2': 'Two', '3': 'A very long string that is… }" ) );
31263126

31273127
QVariantList list;
31283128
list << 1 << 2 << 3;
3129-
QCOMPARE( QgsExpression::formatPreviewString( QVariant( list ) ), QString( "<i>&lt;array: 1, 2, 3&gt;</i>" ) );
3129+
QCOMPARE( QgsExpression::formatPreviewString( QVariant( list ) ), QStringLiteral( "[ 1, 2, 3 ]" ) );
31303130

31313131
QStringList stringList;
31323132
stringList << QStringLiteral( "One" ) << QStringLiteral( "Two" ) << QStringLiteral( "A very long string that is going to be truncated" );
31333133
QCOMPARE( QgsExpression::formatPreviewString( QVariant( stringList ) ),
3134-
QString( "<i>&lt;array: 'One', 'Two', 'A very long string that is going to be trunca…&gt;</i>" ) );
3134+
QStringLiteral( "[ 'One', 'Two', 'A very long string that is going to be tr… ]" ) );
31353135
}
31363136
};
31373137

0 commit comments

Comments
 (0)