Merge pull request #2238 from gforney/master

clean up - move some scripts to a more logical place

Author: gforney

Manuals/scripts/check_manuals.py

@@ -5,7 +5,40 @@
 @author: jhodges
 """
 
-import glob, os
+import os, subprocess, platform, argparse, glob, sys
+
+def sortWhitelist(firemodels):
+    whitelist = os.path.join(firemodels, 'fds','Manuals','Bibliography')+ os.sep + 'whitelist.txt'
+    whitelist = os.path.abspath(whitelist)
+    
+    with open(whitelist,'r') as f:
+        txt = f.readlines()
+    
+    words = list(set(txt[1:]))
+    words.sort()
+    
+    outtxt = txt[0] + '\n' + '\n'.join(words) + '\n'
+    while '\n\n' in outtxt:
+        outtxt = outtxt.replace('\n\n','\n')
+        
+    with open(whitelist.replace('.txt','_back.txt'), 'w') as f:
+        f.writelines(txt)
+        
+    with open(whitelist, 'w') as f:
+        f.write(outtxt)
+
+def checkSpelling(file, firemodels):
+    whitelist = os.path.join(firemodels, 'fds','Manuals','Bibliography')+ os.sep + 'whitelist.txt'
+    whitelist = os.path.abspath(whitelist)
+    if 'Windows' in platform.platform():
+        whitelist = whitelist.replace('\\','/')
+        whitelist = whitelist[0].upper() + whitelist[1:]
+    cmd = ['aspell','--lang=en','--mode=tex','--add-extra-dicts=%s'%(whitelist), 'list', '<', file]
+    
+    p = subprocess.run(cmd, capture_output=True, shell=True)
+    txt = p.stdout.decode('utf-8')
+    txt = txt.replace('\r\n','\n')
+    return txt
 
 def checkCaption(caption):
 
@@ -44,7 +77,7 @@ def checkCaption(caption):
     return outtxt
 
 def check_disallowed_commands(txt, file):
-    disallowed_commands = ['\\bf{','\\tt{']
+    disallowed_commands = [] #['\\bf{','\\tt{']
     outtxt = ''
     for cmd in disallowed_commands:
         split = txt.split(cmd)
@@ -54,7 +87,43 @@ def check_disallowed_commands(txt, file):
                 outtxt = outtxt + "ERROR, %s %s located at line %d\n"%(file, cmd, line_count)
     return outtxt
 
-texfiles = glob.glob('..'+os.sep+'*'+os.sep+'*.tex')
+args = sys.argv
+parser = argparse.ArgumentParser(prog='check_manuals',
+                                 description='checks latex manuals for alignment with FDS developer guidelines')
+parser.add_argument('call')
+parser.add_argument('--file', help='filename to analyze', default='')
+parser.add_argument('--datafile', help='filename containing list of files', default='')
+parser.add_argument('--globfile', help='glob search for files', default='')
+parser.add_argument('--outdir', help='directory to store output', default='')
+parser.add_argument('--outname', help='output filename', default='check_output.err')
+parser.add_argument('--suppressconsole', help='boolean flag specifying whether findings are printed to console', action='store_true')
+
+cmdargs = parser.parse_args(args)
+suppressconsole = cmdargs.suppressconsole
+if cmdargs.file != '':
+    texfiles = [cmdargs.file]
+elif cmdargs.datafile != '':
+    with open(cmdargs.datafile, 'r') as f:
+        texfiles = f.readlines()
+    texfiles = [x.replace('\n','') for x in texfiles]
+elif cmdargs.globfile != '':
+    texfiles = glob.glob(cmdargs.globfile)
+else:
+    if not suppressconsole:
+        print("Warning, one of --file, --datafile, or --globfile is expected. Checking tex files in current directory")
+    texfiles = glob.glob('*.tex')
+
+if not suppressconsole:
+    print("Files to check:")
+    for file in texfiles:
+        print(file)
+outdir = cmdargs.outdir
+outname = cmdargs.outname
+
+firemodels = os.path.join(os.path.dirname(__file__),'..','..','..')
+
+# This can be called if the white list is being edited and you want sort it
+# sortWhitelist(firemodels)
 
 outtxt = '\n'
 for i in range(0, len(texfiles)):
@@ -83,10 +152,23 @@ def check_disallowed_commands(txt, file):
 
     # Check disallowed commands
     outtxt = outtxt + check_disallowed_commands(txt, file)
+    
+    # Check spelling
+    txt = checkSpelling(file, firemodels)
+    
+    if len(txt) > 0:
+        txt_list = list(set(txt.split('\n')))
+        txt_list.sort()
+        #while '\n\n' in txt:
+        #    txt = txt.replace('\n\n','\n')
+        #outtxt = outtxt + '\n\nMisspelt Words in %s:\n'%(file) + '\n'.join(txt_list) + '\n\n'
+        for j in range(0, len(txt_list)):
+            outtxt = outtxt + '\n\nMisspelt Words in %s: %s\n'%(file,txt_list[j])
 
-if len(outtxt) > 1:
+if len(outtxt) > 1 and not suppressconsole:
     print("Warnings identified in the manual check:")
     print(outtxt)
 
-with open('check_output.txt', 'w') as f:
+if outdir != '': outname = outdir + os.sep + outname
+with open(outname, 'w') as f:
     f.write(outtxt)

Source/smokeview/GETDEFS.sh renamed to Source/scripts/GETDEFS.sh

@@ -1,2 +1,3 @@
 #!/bin/bash
+cd ../smokeview
 grep '#ifdef' *.c *.cpp *.h ../shared/*.c ../shared/*.cpp ../shared/*.h | awk '{print $2}' | sort -u

Source/scripts/LINECOUNT.bat

@@ -0,0 +1,5 @@
+@echo off
+set curdir=%CD%
+cd ..\smokeview
+cat *.c *.cpp *.h ..\shared\*.h ..\shared\*.c  | wc -l
+cd %curdir%

Source/scripts/LINECOUNT.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+cd ../smokeview
+cat *.c *.cpp *.h ../shared/*.h ../shared/*.c  | wc -l

Source/smokeview/LINECOUNT_ALL.bat renamed to Source/scripts/LINECOUNT_ALL.bat

@@ -1,2 +1,5 @@
 @echo off
+set curdir=%CD%
+cd ..\smokeview
 cat *.c *.cpp *.h ..\shared\*.c ..\shared\*.h ..\background\*.c ..\background\*.h ..\smokediff\*.h ..\smokediff\*.c ..\smokezip\*.c ..\smokezip\*.h ..\wind2fds\*.c ..\wind2fds\*.h | wc -l
+cd %curdir%

Source/scripts/LINECOUNT_ALL.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+cd ../smokeview
+cat *.c *.cpp *.h ../shared/*.c ../shared/*.h ../background/*.c ../background/*.h ../smokediff/*.h ../smokediff/*.c ../smokezip/*.c ../smokezip/*.h ../wind2fds/*.c ../wind2fds/*.h| wc -l

Source/smokeview/make_po_template.sh renamed to Source/scripts/make_po_template.sh

@@ -2,4 +2,5 @@
 
 MAKEPO=../../makepo/intel_linux_64/makepo_linux_64
 #cat *.c *.cpp | $MAKEPO | sort -u | $MAKEPO -a > smokeview_template.po
+cd ../smokeview
 cat *.c *.cpp | $MAKEPO | sort -u  > smokeview_template.po