remove unused HRC defines in sd/

improve the existing 'find unused RID constants' script

Change-Id: I6facbf9ef929bd31dc59eba4a1807c72b87cdb2f
Reviewed-on: https://gerrit.libreoffice.org/35186
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>

1 files changed, 35 insertions, 29 deletions

diff --git a/bin/find-unused-rid.py b/bin/find-unused-defines-in-hrc-files.py
index 82ea29303b0c..f24e1a61b6fe 100755
--- a/bin/find-unused-rid.py
+++ b/bin/find-unused-defines-in-hrc-files.py
@@ -1,10 +1,11 @@
 #!/usr/bin/python
 
-# Search for unused RID_ constants.
+# Search for unused constants in .hrc files.
 #
-# Note that sometimes RID constants are calculated, so some careful checking of the output is necessary.
+# Note that sometimes these constants are calculated, so some careful checking of the output is necessary.
+#
+# Takes about 4 hours to run this on a fast machine with an SSD
 #
-# Takes about 30min to run this on a fast machine.
 
 import subprocess
 import sys
@@ -55,49 +56,54 @@ exclusionSet = set([
     "RID_SVXSTR_TRASNGR",
     # other places doing calculations
     "RID_SVXSTR_DEPTH",
-    "RID_SUBSETSTR_"
+    "RID_SUBSETSTR_",
+    "ANALYSIS_"
     ])
 
 
-def startswith_one_of( a, aset ):
-    for f in aset:
+def in_exclusion_set( a ):
+    for f in exclusionSet:
         if a.startswith(f):
             return True;
     return False;
 
-a = subprocess.Popen("git grep -P '^#define\s+RID_\w+\s+' -- *.hrc | sort -u", stdout=subprocess.PIPE, shell=True)
+a = subprocess.Popen("git grep -hP '^#define\s+\w+\s+' -- *.hrc | sort -u", stdout=subprocess.PIPE, shell=True)
 
 with a.stdout as txt:
     for line in txt:
         idx1 = line.find("#define ")
         idx2 = line.find(" ", idx1 + 9)
-        ridName = line[idx1+8 : idx2]
+        idName = line[idx1+8 : idx2]
         # the various _START and _END constants are normally unused outside of the .hrc and .src files, and that's fine
-        if ridName.endswith("_START"): continue
-        if ridName.endswith("_BEGIN"): continue
-        if ridName.endswith("_END"): continue
-        if ridName == "RID_GROUPS_SFXOFFSET": continue
-        if ridName == "RID_SVX_FIRSTFREE": continue
-        if startswith_one_of(ridName, exclusionSet): continue
+        if idName.endswith("_START"): continue
+        if idName.endswith("_BEGIN"): continue
+        if idName.endswith("_END"): continue
+        if idName.startswith("RID_"):
+            if idName == "RID_GROUPS_SFXOFFSET": continue
+            if idName == "RID_SVX_FIRSTFREE": continue
+        if in_exclusion_set(idName): continue
         # search for the constant
-        b = subprocess.Popen(["git", "grep", "-w", ridName], stdout=subprocess.PIPE)
-        # check if we found one in actual code
-        found_in_code = False
-        # check that the constant is not being used as an identifier by MenuItem entries in .src files
-        found_menu_identifier = False
-        # check that the constant is not being used by the property controller extension or report inspection, which use macros
-        # to declare constants, hiding them from a search
-        found_property_macros = False
+        b = subprocess.Popen(["git", "grep", "-wl", idName], stdout=subprocess.PIPE)
+        found_reason_to_exclude = False
         with b.stdout as txt2:
             for line2 in txt2:
-                if not line2.endswith(".hrc") and not line2.endswith(".src"): found_in_code = True
-                if line2.find("Identifier = ") != -1: found_menu_identifier = True
-                if line2.find("extensions/source/propctrlr") != -1: found_property_macros = True
-                if line2.find("reportdesign/source/ui/inspection/inspection.src") != -1: found_property_macros = True
-        if not found_in_code and not found_menu_identifier and not found_property_macros:
-            sys.stdout.write(ridName + '\n')
+                line2 = line2.strip() # otherwise the comparisons below will not work
+                # check if we found one in actual code
+                if not line2.endswith(".hrc") and not line2.endswith(".src"): found_reason_to_exclude = True
+                if idName.startswith("RID_"):
+                        # check that the constant is not being used as an identifier by entries in .src files
+                        if line2.endswith(".src") and line2.find("Identifier = ") != -1: found_reason_to_exclude = True
+                        # check that the constant is not being used by the property controller extension or reportdesigner inspection,
+                        # which use macros to declare constants, hiding them from a search
+                        if line2.find("extensions/source/propctrlr") != -1: found_reason_to_exclude = True
+                        if line2.find("reportdesign/source/ui/inspection/inspection.src") != -1: found_reason_to_exclude = True
+                if idName.startswith("HID_"):
+                        # check that the constant is not being used as an identifier by entries in .src files
+                        if line2.endswith(".src") and line2.find("HelpId = ") != -1: found_reason_to_exclude = True
+        if not found_reason_to_exclude:
+            sys.stdout.write(idName + '\n')
             # otherwise the previous line of output will be incorrectly mixed into the below git output, because of buffering
             sys.stdout.flush()
             # search again, so we log the location and filename of stuff we want to remove
-            subprocess.call(["git", "grep", "-wn", ridName])
+            subprocess.call(["git", "grep", "-wn", idName])