From 586da70a5ad7c40398a02a06bcf989752a53d4ff Mon Sep 17 00:00:00 2001 From: Andrey Lihatskiy Date: Mon, 20 Nov 2023 10:45:32 +0200 Subject: Added the script for adjusting XUI xml format --- scripts/code_tools/fix_xml_indentations.py | 82 ++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 scripts/code_tools/fix_xml_indentations.py (limited to 'scripts') diff --git a/scripts/code_tools/fix_xml_indentations.py b/scripts/code_tools/fix_xml_indentations.py new file mode 100644 index 0000000000..03cf980247 --- /dev/null +++ b/scripts/code_tools/fix_xml_indentations.py @@ -0,0 +1,82 @@ +import os +import sys +import glob +import io +import xml.etree.ElementTree as ET + +def parse_xml_file(file_path): + try: + tree = ET.parse(file_path) + return tree + except ET.ParseError as e: + print(f"Error parsing XML file {file_path}: {e}") + return None + +def indent(elem, level=0, indent_text=False, indent_tab=False): + indent_string = "\t" if indent_tab else " " + i = "\n" + level * indent_string + if len(elem): + if not elem.text or not elem.text.strip(): + elem.text = i + indent_string + if not elem.tail or not elem.tail.strip(): + elem.tail = i + for elem in elem: + indent(elem, level + 1, indent_text, indent_tab) + if not elem.tail or not elem.tail.strip(): + elem.tail = i + else: + if level and (not elem.tail or not elem.tail.strip()): + elem.tail = i + if indent_text and elem.text and not elem.text.isspace(): + elem.text = "\n" + (level + 1) * indent_string + elem.text.strip() + "\n" + level * indent_string + +def save_xml(tree, file_path, indent_text=False, indent_tab=False, rm_space=False): + if tree is not None: + root = tree.getroot() + indent(root, indent_text=indent_text, indent_tab=indent_tab) + xml_string = ET.tostring(root, encoding='unicode') + if rm_space: + xml_string = xml_string.replace(' />', '/>') + try: + with io.open(file_path, 'wb') as file: + file.write('\n'.encode('utf-8')) + file.write(xml_string.encode('utf-8')) + except IOError as e: + print(f"Error saving file {file_path}: {e}") + +def process_directory(directory_path, indent_text=False, indent_tab=False, rm_space=False): + if not os.path.isdir(directory_path): + print(f"Directory not found: {directory_path}") + return + + xml_files = glob.glob(os.path.join(directory_path, "*.xml")) + if not xml_files: + print(f"No XML files found in directory: {directory_path}") + return + + for file_path in xml_files: + tree = parse_xml_file(file_path) + if tree is not None: + save_xml(tree, file_path, indent_text, indent_tab, rm_space) + + +if __name__ == "__main__": + if len(sys.argv) < 2 or '--help' in sys.argv: + print("XML Formatter Script") + print("This script formats XML files in a given directory with options for indentation and space removal.") + print("\nUsage:") + print(" python script_name.py [options]") + print("\nOptions:") + print(" --indent-text Indents text within XML tags.") + print(" --indent-tab Uses tabs instead of spaces for indentation.") + print(" --rm-space Removes spaces in self-closing tags.") + print("\nCommon Usage:") + print(" To format XML files with text indentation, tab indentation, and removal of spaces in self-closing tags:") + print(" python script_name.py /path/to/xmls --indent-text --indent-tab --rm-space") + sys.exit(1) + + directory_path = sys.argv[1] + indent_text = '--indent-text' in sys.argv + indent_tab = '--indent-tab' in sys.argv + rm_space = '--rm-space' in sys.argv + process_directory(directory_path, indent_text, indent_tab, rm_space) -- cgit v1.2.3 From 2c93819d27f56a6628e20d959828b7afdf510782 Mon Sep 17 00:00:00 2001 From: Andrey Lihatskiy Date: Tue, 21 Nov 2023 00:16:33 +0200 Subject: XML formatter script - added license --- scripts/code_tools/fix_xml_indentations.py | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'scripts') diff --git a/scripts/code_tools/fix_xml_indentations.py b/scripts/code_tools/fix_xml_indentations.py index 03cf980247..46f7931589 100644 --- a/scripts/code_tools/fix_xml_indentations.py +++ b/scripts/code_tools/fix_xml_indentations.py @@ -1,3 +1,31 @@ +#!/usr/bin/env python3 +"""\ + +This script formats XML files in a given directory with options for indentation and space removal. + +$LicenseInfo:firstyear=2023&license=viewerlgpl$ +Second Life Viewer Source Code +Copyright (C) 2023, Linden Research, Inc. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; +version 2.1 of the License only. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA +$/LicenseInfo$ +""" + + import os import sys import glob -- cgit v1.2.3 From 6e63fe32efd4336995720f43de4ba7110f69c09f Mon Sep 17 00:00:00 2001 From: Andrey Lihatskiy Date: Fri, 24 Nov 2023 09:40:27 +0200 Subject: XML formatter script - added control for the declaration tag --- scripts/code_tools/fix_xml_indentations.py | 39 +++++++++++++++++++++--------- 1 file changed, 28 insertions(+), 11 deletions(-) (limited to 'scripts') diff --git a/scripts/code_tools/fix_xml_indentations.py b/scripts/code_tools/fix_xml_indentations.py index 46f7931589..c0661dd975 100644 --- a/scripts/code_tools/fix_xml_indentations.py +++ b/scripts/code_tools/fix_xml_indentations.py @@ -25,13 +25,19 @@ Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA $/LicenseInfo$ """ - import os import sys import glob import io import xml.etree.ElementTree as ET +def get_xml_declaration(file_path): + with open(file_path, 'r', encoding='utf-8') as file: + first_line = file.readline().strip() + if first_line.startswith('', '/>') + + xml_decl = ( + xml_decl if (xml_decl and not rewrite_decl) else ( + '' + if rm_space else + '' + ) + ) + try: with io.open(file_path, 'wb') as file: - file.write('\n'.encode('utf-8')) + file.write(xml_decl.encode('utf-8')) + file.write('\n'.encode('utf-8')) file.write(xml_string.encode('utf-8')) except IOError as e: print(f"Error saving file {file_path}: {e}") -def process_directory(directory_path, indent_text=False, indent_tab=False, rm_space=False): +def process_directory(directory_path, indent_text=False, indent_tab=False, rm_space=False, rewrite_decl=False): if not os.path.isdir(directory_path): print(f"Directory not found: {directory_path}") return @@ -83,28 +99,29 @@ def process_directory(directory_path, indent_text=False, indent_tab=False, rm_sp return for file_path in xml_files: + xml_decl = get_xml_declaration(file_path) tree = parse_xml_file(file_path) if tree is not None: - save_xml(tree, file_path, indent_text, indent_tab, rm_space) - + save_xml(tree, file_path, xml_decl, indent_text, indent_tab, rm_space, rewrite_decl) if __name__ == "__main__": if len(sys.argv) < 2 or '--help' in sys.argv: - print("XML Formatter Script") - print("This script formats XML files in a given directory with options for indentation and space removal.") + print("This script formats XML files in a given directory. Useful to fix XUI XMLs after processing by other tools.") print("\nUsage:") - print(" python script_name.py [options]") + print(" python fix_xml_indentations.py [options]") print("\nOptions:") print(" --indent-text Indents text within XML tags.") print(" --indent-tab Uses tabs instead of spaces for indentation.") print(" --rm-space Removes spaces in self-closing tags.") + print(" --rewrite_decl Replaces the XML declaration line.") print("\nCommon Usage:") print(" To format XML files with text indentation, tab indentation, and removal of spaces in self-closing tags:") - print(" python script_name.py /path/to/xmls --indent-text --indent-tab --rm-space") + print(" python fix_xml_indentations.py /path/to/xmls --indent-text --indent-tab --rm-space") sys.exit(1) directory_path = sys.argv[1] indent_text = '--indent-text' in sys.argv indent_tab = '--indent-tab' in sys.argv rm_space = '--rm-space' in sys.argv - process_directory(directory_path, indent_text, indent_tab, rm_space) + rewrite_decl = '--rewrite_decl' in sys.argv + process_directory(directory_path, indent_text, indent_tab, rm_space, rewrite_decl) -- cgit v1.2.3 From 9bf5ad98e508690efd334806885b6d1666bee602 Mon Sep 17 00:00:00 2001 From: Andrey Lihatskiy Date: Fri, 24 Nov 2023 09:49:19 +0200 Subject: XML formatter script - simplify the default declaration --- scripts/code_tools/fix_xml_indentations.py | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) (limited to 'scripts') diff --git a/scripts/code_tools/fix_xml_indentations.py b/scripts/code_tools/fix_xml_indentations.py index c0661dd975..019f6db23c 100644 --- a/scripts/code_tools/fix_xml_indentations.py +++ b/scripts/code_tools/fix_xml_indentations.py @@ -72,13 +72,8 @@ def save_xml(tree, file_path, xml_decl, indent_text=False, indent_tab=False, rm_ if rm_space: xml_string = xml_string.replace(' />', '/>') - xml_decl = ( - xml_decl if (xml_decl and not rewrite_decl) else ( - '' - if rm_space else - '' - ) - ) + xml_decl = (xml_decl if (xml_decl and not rewrite_decl) + else '') try: with io.open(file_path, 'wb') as file: -- cgit v1.2.3