github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-10 21:29:20 +00:00
Code Issues Projects Releases Wiki Activity

config_tools: support dynamic enum names in XML schema

Browse Source 
The dynamic enum mechanism today only allows specifying the enum values
using XPATH. While this is sufficient from functionality point of view, it
may not provide the best experience as users have to understand the raw
data used internally. The typical way to present more informational labels
of enum values to users is enum names which cannot be supported by the
current XML schema to JSONSchema converter.

This patch allows the XML schema to specify dynamic enum names by adding an
`acrn:option-names` attribute to an element. The attribute is interpreted
as an XPATH which evaluates to a sequence of the same length of
`acrn-options`. The element at index i in that sequence is considered the
enum name of the enum value at index i of the results of `acrn:options`.

This mechanism is first applied to the `pcpu_id` element to indicate
whether a physical CPU is P-core or E-core.

Tracked-On: #8050
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Junjie Mao
2022-08-24 22:04:32 +08:00
committed by acrnsi-robot
parent 9ebaa1cb69
commit df68c7ad2e
3 changed files with 28 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
misc/config_tools/scenario_config/jsonschema/converter.py
View File

@@ -340,11 +340,13 @@ class XS2JS:
# get description
if 'xs:annotation' in element:
annotation = element['xs:annotation']
# title
js_ele['title'] = element['xs:annotation'].get('@acrn:title', name)
js_ele['title'] = annotation.get('@acrn:title', name)
# documentation
documentation: str = element['xs:annotation'].get('xs:documentation', None)
documentation: str = annotation.get('xs:documentation', None)
if documentation is None or documentation.strip() == '':
documentation = ''
if documentation:
@@ -352,13 +354,14 @@ class XS2JS:
js_ele['description'] = documentation
# dynamic enum
if '@acrn:options' in element['xs:annotation'] and 'dynamicEnum' in self.features:
if '@acrn:options' in annotation and 'dynamicEnum' in self.features:
dynamic_enum = {
'type': 'dynamicEnum',
'function': 'get_enum',
'source': 'board_xml',
'selector': element['xs:annotation']['@acrn:options'],
'sorted': element['xs:annotation'].get('@acrn:options-sorted-by', None)
'selector': annotation['@acrn:options'],
'name-selector': annotation['@acrn:option-names'] if '@acrn:option-names' in annotation else annotation['@acrn:options'],
'sorted': annotation.get('@acrn:options-sorted-by', None)
}
# enum should be applied to array items instead of array itself
if 'items' in js_ele:
@@ -367,10 +370,10 @@ class XS2JS:
js_ele['enum'] = dynamic_enum
# widget and its options
self.convert_widget_config(element['xs:annotation'], js_ele)
self.convert_widget_config(annotation, js_ele)
# Error messages
self.convert_errormsg_config(element['xs:annotation'], js_ele)
self.convert_errormsg_config(annotation, js_ele)
properties[name] = js_ele