Merge pull request #5 from jgOhYeah/verboseSwitchAttempt2

Making the preproccessor quieter by default (verbose option)

Author: Patronics

.gitignore

@@ -0,0 +1 @@
+*.pyc

picaxepreprocess.py

@@ -26,6 +26,8 @@
                   # showing an error.
 use_ifs = True # Whether to evaluate preprocessor if statements
 
+verbose = False
+
 # Default options to pass to the compiler
 port = "/dev/ttyUSB0"
 chip = "08m2" # Must be lowercase m or x if included
@@ -52,6 +54,7 @@ def print_help():
     -s, --syntax       Send the file to the compiler for a syntax check only (no download)
         --nocolor      Disable terminal colour for systems that do not support it (Windows).
         --noifs        Disable evaluation of #if and #ifdef - this will be left to the compiler if present.
+        --verbose      Print preproccessor debugging info
     -h, --help         Display this help
 
 Optional switches only used if sending to the compiler
@@ -91,6 +94,7 @@ def main(argv):
     global compiler_path
     global use_colour
     global use_ifs
+    global verbose
 
     # Use the last argument as the file name if it does not start with a dash
     if (len(argv) == 1 or len(argv) >= 2 and argv[-2] not in ("-o", "-v", "-c")) and argv[-1][0] != "-": # Double check the second last is -i if needed
@@ -101,7 +105,7 @@ def main(argv):
                 argv.pop() # Remove the -i option as it has been parsed here.
 
     try:
-        opts, _ = getopt.getopt(argv,"hi:o:uv:sfc:detpP:",["help", "ifile=","ofile=","upload","variant=","syntax","firmware","comport=","debug","debughex","edebug","edebughex","term","termhex","termint", "pass", "tidy", "compilepath=", "nocolor", "noifs"])
+        opts, _ = getopt.getopt(argv,"hi:o:uv:sfc:detpP:",["help", "ifile=","ofile=","upload","variant=","syntax","firmware","comport=","debug","debughex","edebug","edebughex","term","termhex","termint", "pass", "tidy", "compilepath=", "nocolor", "noifs", "verbose"])
     except getopt.GetoptError:
         print_help()
         sys.exit(2)
@@ -148,6 +152,9 @@ def main(argv):
             tidy = True
         elif opt in ("-P", "--compilepath"): #chose non-default path to compilers
             compiler_path = os.path.join(arg,'') #adds trailing slash if needed
+        elif opt in ("--verbose"): # Print out info as the preproccessor is running
+            verbose = True
+
     if not os.path.exists(inputfilename):
         if (inputfilename == "main.bas"):    #show help if likely run with no arguments
             preprocessor_error("'{}/{}' does not exist. Either specify an input file or put it in the same folder as this script with the name 'main.bas'".format(os.getcwd(), inputfilename), True)
@@ -207,7 +214,7 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
     global chip
     global port
     savingmacro=False
-    print("\nIncluding file " + curfilename)
+    preprocessor_info("\nIncluding file " + curfilename)
     path=os.path.dirname(os.path.abspath(inputfilename))+"/"
     if curfilename.startswith("/"):    #decide if an absolute or relative path
         curpath=""
@@ -255,13 +262,13 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                     key = workingline.replace("'", " ").replace(";", " ").strip().split()[1]
                     active = is_if_active(0) and key in definitions
                     if_stack.append((active, active))
-                    print("{}: #ifdef. Stack is now: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #ifdef. Stack is now: {}".format(count+1, if_stack))
                     line = "; {}".format(line)
                 elif use_ifs and workingline.lower().startswith("#ifndef"):
                     key = workingline.replace("'", " ").replace(";", " ").strip().split()[1]
                     active = is_if_active(0) and key not in definitions
                     if_stack.append((active, active))
-                    print("{}: #ifndef. Stack is now: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #ifndef. Stack is now: {}".format(count+1, if_stack))
                     line = "; {}".format(line)
                 # Ifs will be treated separately later after definitions are substituted.
                 elif use_ifs and workingline.lower().startswith("#elseifdef"): # ELSE and ELSEIF
@@ -272,7 +279,7 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                     active = is_if_active(1) and not if_stack[-1][1] and key in definitions
                     if_stack[-1] = (active, if_stack[-1][1] or active)
                     line = "; {}".format(line)
-                    print("{}: #elseifdef. Stack is now: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #elseifdef. Stack is now: {}".format(count+1, if_stack))
                 elif use_ifs and workingline.lower().startswith("#elseifndef"):
                     if len(if_stack) == 0:
                         preprocessor_error("""Too many elses or not enough ifs.
@@ -281,13 +288,13 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                     active = is_if_active(1) and not if_stack[-1][1] and key not in definitions
                     if_stack[-1] = (active, if_stack[-1][1] or active)
                     line = "; {}".format(line)
-                    print("{}: #elseifndef. Stack is now: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #elseifndef. Stack is now: {}".format(count+1, if_stack))
                 elif use_ifs and workingline.lower().startswith("#else") and len(workingline.strip().split()[0]) == 5: # Else only - not elseif
                     if len(if_stack) == 0:
                         preprocessor_error("""Too many elses or not enough ifs.
     Error is before or at line {} in '{}'.""".format(count+1,curfilename))
                     if_stack[-1] = (is_if_active(1) and not if_stack[-1][1], True)
-                    print("{}: #else. Stack is now: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #else. Stack is now: {}".format(count+1, if_stack))
                     # elsif only will be evaluated after definitions are substituted.
                     line = "; {}".format(line)
                 elif use_ifs and workingline.lower().startswith("#endif"):
@@ -296,7 +303,7 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
     Error is before or at line {} in '{}'.""".format(count+1,curfilename))
                     else:
                         if_stack.pop()
-                    print("{}: #endif. Stack afterwards is: {}".format(count+1, if_stack))
+                    preprocessor_info("{}: #endif. Stack afterwards is: {}".format(count+1, if_stack))
                     line = "; {}".format(line)
                 elif workingline.lower().startswith("#undef"): # Put undef up here so that substitutions happen afterwards
                     workingline=workingline[7:].lstrip().split("'")[0].split(";")[0].rstrip()
@@ -311,9 +318,9 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                     # Substitute defines (before it is added so that the define itself is not replaced)
                     for key,value in definitions.items():
                         if key in line:
-                            print("Replacing '{}' with ".format(line.strip()), end="")
+                            preprocessor_info("Replacing '{}' with ".format(line.strip()), end="")
                             line = replace(key, value,line) # Replace whole words only that are not in strings or comments
-                            print("'{}'".format(line.strip()))
+                            preprocessor_info("'{}'".format(line.strip()))
                             # line=line+"      'DEFINE: "+value+" SUBSTITUTED FOR "+key+"\n"
                     for key, macrovars in macros.items():
                         if key in line:
@@ -329,12 +336,17 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
 
                                     macrocontents=macrocontents.split(",")[1].strip() # Remove the first parameter nd try again 
                                 else:
-                                    print("finished parsing macro contents")
+                                    preprocessor_info("finished parsing macro contents")
                                     params[argnum]=macrocontents.split(",")[0].rstrip()
-                                    print(params)
+                                    preprocessor_info(params)
                                     break
                             line = replace(key, macrovars[0], line)
-                            print(macrovars)
+
+                            # # Make sure each line is commented out in a multiline macro if the surrounding code should be commented out
+                            if not is_if_active(0):
+                                line = line.replace("\n", "\n; ")
+
+                            preprocessor_info(macrovars)
                             for num, name in macrovars.items():
                                     if name in line:
                                         if num>0:
@@ -345,21 +357,21 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                         active = is_if_active(1) and evaluate_basic(line.lstrip()[4:], count + 1, curfilename)
                         if_stack.append((active, active))
                         line = "; {}".format(line)
-                        print("{}: #if. Stack is now: {}".format(count+1, if_stack))
+                        preprocessor_info("{}: #if. Stack is now: {}".format(count+1, if_stack))
                     elif use_ifs and workingline.lower().startswith("#elseif "):
                         if len(if_stack) == 0:
                             preprocessor_error("""Not enough ifs.
     Error is before or at line {} in '{}'.""".format(count+1,curfilename))
                         active = is_if_active(1) and not if_stack[-1][1] and evaluate_basic(line.lstrip()[8:], count + 1, curfilename)
                         if_stack[-1] = (active, if_stack[-1][1] or active)
-                        print("{}: #elseif. Stack is now: {}".format(count+1, if_stack))
+                        preprocessor_info("{}: #elseif. Stack is now: {}".format(count+1, if_stack))
 
                 if is_if_active(0):
                     # Preprocessor check
                     if workingline.lower().startswith("#include"):
                         workingline=workingline[9:].lstrip().split("'")[0].split(";")[0].rstrip()     #remove #include text, comments, and whitespace
                         workingline=workingline.strip('"')         #remove quotation marks around path
-                        #print(workingline)
+                        #preprocessor_info(workingline)
                         with open (outputfilename, 'a') as output_file:
                             output_file.write("'---BEGIN "+workingline+" ---\n")
                         progparse(workingline,count+1,curfilename) # +1 for 0 indexing
@@ -368,7 +380,7 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                         try:
                             definitions[workingline.split()[0]]=(workingline.split(None,1)[1])   #add to dictionary of definitions
                         except:
-                            print("Old define found, leaving intact")
+                            preprocessor_info("Old define found, leaving intact")
                             # Make it replace any call to itdelf with itself so that it is in the dictionary for ifdef
                             definitions[workingline.split()[0]] = workingline.split()[0]
 
@@ -384,14 +396,14 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                     elif workingline.lower().startswith("#com"): # Set the serial port
                         port = workingline[5:].lstrip().split("'")[0].split(";")[0].rstrip()     # Remove #com text, comments, and whitespace
                         port = port.strip('"')         #remove quotation marks around path
-                        print("Setting serial port to '{}'".format(port))
+                        preprocessor_info("Setting serial port to '{}'".format(port))
                         with open (outputfilename, 'a') as output_file:
                             output_file.write(line.rstrip()+"      'SERIAL PORT PARSED\n")
                     elif workingline.lower().startswith("#macro"):     #Automatically substitute #macros
                         savingmacro=True
                         workingline=workingline[7:].lstrip().split("'")[0].split(";")[0].rstrip()
                         macroname=workingline.split("(")[0].rstrip()
-                        print(macroname)
+                        preprocessor_info(macroname)
                         with open (outputfilename, 'a') as output_file:
                             output_file.write("'PARSED MACRO "+macroname)
                         macrocontents=workingline.split("(")[1].rstrip()
@@ -400,17 +412,17 @@ def progparse(curfilename, called_from_line=None, called_from_file=None):
                         while(1):
                             argnum+=1
                             if macrocontents.strip()==")":
-                                print("no parameters to macro")
-                                macros[macroname][0]="'Start of macro: "+macroname
-                                print(macros)
+                                preprocessor_info("no parameters to macro")
+                                macros[macroname][0]="'Start of macro: "+macroname+"\n"
+                                preprocessor_info(macros)
                                 break
                             else:
                                 macrocontents=macrocontents.rstrip(")").strip("(")
                                 macros[macroname][argnum]=macrocontents.split(",")[0].rstrip()   #create spot in dictionary for macro variables, but don't populate yet
                                 if "," in macrocontents:
                                     macrocontents=macrocontents.split(",")[1].strip().rstrip()
                                 else:
-                                    print("finished parsing macro contents")
+                                    preprocessor_info("finished parsing macro contents")
                                     macros[macroname][0]="'--START OF MACRO: "+macroname+"\n"
                                     break
                     elif savingmacro==True:
@@ -502,7 +514,7 @@ def set_chip(new_chip: str) -> None:
                    "28x2", "40x2"]
     new_chip = new_chip.lower() # In case of 08M2 or 08m2
     if new_chip in valid_chips:
-        print("Setting the PICAXE chip to: '{}'".format(new_chip))
+        preprocessor_info("Setting the PICAXE chip to: '{}'".format(new_chip))
         chip = new_chip
         if (chip == "40x2"):
            chip = "28x2"   #28x2 and 40x2 use the same compiler
@@ -542,6 +554,10 @@ def preprocessor_warning(msg):
         print("\u001b[0m", end="") # Reset
     print(msg)
 
+def preprocessor_info(*values, **kwargs):
+    """ Prints an info message if in verbose mode, otherwise does nothing. """
+    if verbose:
+        print(*values, **kwargs)
 
 if __name__ == "__main__":
     main(sys.argv[1:])

readme.md

@@ -34,6 +34,7 @@ Optional switches
     -s, --syntax       Send the file to the compiler for a syntax check only (no download)
         --nocolor      Disable terminal colour for systems that do not support it (Windows).
         --noifs        Disable evaluation of #if and #ifdef - this will be left to the compiler if present.
+        --verbose      Print preproccessor debugging info
     -h, --help         Display this help
 
 Optional switches only used if sending to the compiler