Vulkan-Docs/scripts/spec_tools/data_structures.py

65 lines
1.7 KiB
Python
Raw Normal View History

Change log for August 17, 2019 Vulkan 1.1.120 spec update: * Update release number to 120. Github Issues: * Add slink:VkAccelerationStructureTypeNV explicitly to extension XML for `<<VK_NV_ray_tracing>>` (public issue 848). * Add missing valid usage statements for feature flags in slink:VkCommandBufferInheritanceInfo (public pull request 1017). Internal Issues: * Clarify behavior of non-premultiplied destination colors for `<<VK_EXT_blend_operation_advanced>>` prior to the definition of slink:VkBlendOverlapEXT (internal issue 1766). * Fix the confusing phrasing "`no other queue must: be (doing something)`" for flink:vkQueuePresentKHR, flink:vkQueueSubmit, and flink:vkQueueBindSparse (internal issue 1774). * Add `<<VK_EXT_validation_features>>` flag to enable best practices checks, which will soon be available in the validation layer (internal issue 1779). * Specify allowed characters for VUID tag name components in the style guide (internal issue 1788). * Update links to SPIR-V extension specifications, and parameterize their markup in case the URLs change in the future (internal issue 1797). * Fix an off-by-one error in the valid usage statement for slink:VkPipelineExecutableInfoKHR (internal merge request 3303). * Clean up markup indentation not matching the style guide (internal merge request 3314). * Minor script updates to allow refpage aliases, generate a dynamic TOC for refpages, generate Apache rewrite rules for aliases, open external links from refpages in a new window, and synchronize with the OpenCL scripts. This will shortly enable a paned navigation setup for refpages, similar to the OpenCL 2.2 refpages (internal merge request 3322). * Script updates to add tests to the checker, refactor and reformat code, generate better text for some valid usage statements, use more Pythonic idioms, and synchronize with the OpenXR scripts (internal merge request 3239). * Script updates and minor fixes in spec language to not raise checker errors for refpage markup of pages not existing in the API, such as VKAPI_NO_STDINT_H. Remove corresponding suppression of some check_spec_links.py tests from .gitlab-ci.yml and 'allchecks' target (internal merge request 3315).
2019-08-17 15:33:21 -07:00
#!/usr/bin/python3 -i
#
# Copyright (c) 2019 Collabora, Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Author(s): Ryan Pavlik <ryan.pavlik@collabora.com>
"""Provides general-purpose data structures."""
class DictOfStringSets:
"""A dictionary where the values are sets of strings.
Has some convenience functions to allow easier maintenance via
the .add method."""
def __init__(self, d=None):
self.d = {}
if d:
for k, v in d.items():
self.add(k, v)
def __getitem__(self, k):
return self.d[k]
def __contains__(self, k):
return k in self.d
def get(self, k, default=None):
return self.d.get(k, default)
def get_dict(self):
return self.d
def items(self):
"""Return an iterator like dict().items()."""
return self.d.items()
def keys(self):
"""Return an iterator over keys."""
return self.d.keys()
def add_key(self, k):
"""Ensure the set for the given key exists."""
if k not in self.d:
self.d[k] = set()
def add(self, k, v):
self.add_key(k)
if isinstance(v, str):
v = (v, )
if not isinstance(v, set):
v = set(v)
self.d[k].update(v)