update: typo in README

CodePurble · CodePurble · commit 721f7ad60b8b · 2021-02-25T12:07:46.000+05:30
diff --git a/README.md b/README.md
@@ -35,7 +35,10 @@ optional arguments:
                         Generate projects files for IDE. Options are: vscode
   -r, --runFromRAM      Run the program from RAM rather than flash
   -uart, --uart         Console output to UART (default)
-  -usb, --usb           Console output to USB (disables other USB functionality
+  -nouart, --nouart     Disable console output to UART
+  -usb, --usb           Console output to USB (disables other USB functionality)
+   cpp, --cpp           Generate C++ code
+  -d DEBUGGER, --debugger DEBUGGER   Select debugger (0 = SWD, 1 = PicoProbe)
 ```
 You can list the features supported by the tools by using `./pico_project --list`. These features can
 be added to the project using the `--feature` options, this can be used multiple times.
@@ -58,14 +61,20 @@ Code Options | Description
 -------------| -----------
 Add examples for Pico library | Example code will be generated for some of the standard library features that by default are in the build, for example, UART support and HW dividers.
 Run from RAM | Usually, the build creates a binary that will be installed to the flash memory. This forces the binary to work directly from RAM.
+Generate C++ | Any generated source files will use the .cpp extension.
 Advanced  | Brings up a table allowing selection of specific board build options. These options alter the way the features work, and should be used with caution.
 
 
 Build Options | Description
 --------------| -----------
 Run Build | Once the project has been created, build it. This will produce files ready for download to the Raspberry Pi Pico.
 Overwrite Project | If a project already exists in the specified folder, overwrite it with the new project. This will overwrite any changes you may have made.
+
+IDE Options | Description
+------------| -----------
+
 Create VSCode Project | As well as the CMake files, also create the appropriate Visual Studio Code project files.
+Debugger | Use the specified debugger in the IDE
 
 
 
diff --git a/pico_project.py b/pico_project.py
@@ -60,6 +60,9 @@
     'div' :     ("Low level HW Divider",    "divider.c",  "hardware/divider.h",   "hardware_divider")
 }
 
+debugger_list = ["SWD", "PicoProbe"]
+debugger_config_list = ["raspberrypi-swd.cfg", "picoprobe.cfg"]
+
 DEFINES = 0
 INITIALISERS = 1
 # Could add an extra item that shows how to use some of the available functions for the feature
@@ -202,7 +205,8 @@
 isWindows = False
 
 class Parameters():
-    def __init__(self, sdkPath, projectRoot, projectName, gui, overwrite, build, features, projects, configs, runFromRAM, examples, uart, usb):
+    def __init__(self, sdkPath, projectRoot, projectName, gui, overwrite, build, features, projects,
+                 configs, runFromRAM, examples, uart, usb, cpp, debugger, exceptions, rtti):
         self.sdkPath = sdkPath
         self.projectRoot = projectRoot
         self.projectName = projectName
@@ -216,6 +220,10 @@ def __init__(self, sdkPath, projectRoot, projectName, gui, overwrite, build, fea
         self.wantExamples = examples
         self.wantUART = uart
         self.wantUSB = usb
+        self.wantCPP = cpp
+        self.debugger = debugger
+        self.exceptions = exceptions
+        self.rtti = rtti
 
 def GetBackground():
     return 'white'
@@ -240,6 +248,8 @@ def RunGUI(sdkpath, args):
     ttk.Style().configure("TRadiobutton", foreground=GetTextColour(), background=GetBackground() )
     ttk.Style().configure("TLabelframe", foreground=GetTextColour(), background=GetBackground() )
     ttk.Style().configure("TLabelframe.Label", foreground=GetTextColour(), background=GetBackground() )
+    ttk.Style().configure("TCombobox", foreground=GetTextColour(), background=GetBackground() )
+    ttk.Style().configure("TListbox", foreground=GetTextColour(), background=GetBackground() )
 
     app = ProjectWindow(root, sdkpath, args)
 
@@ -642,7 +652,7 @@ def init_window(self, args):
 
         # Code options section
         coptionsSubframe = ttk.LabelFrame(mainFrame, relief=tk.RIDGE, borderwidth=2, text="Code Options")
-        coptionsSubframe.grid(row=optionsRow, column=0, columnspan=5, rowspan=2, padx=5, pady=5, ipadx=5, ipady=3, sticky=tk.E+tk.W)
+        coptionsSubframe.grid(row=optionsRow, column=0, columnspan=5, rowspan=3, padx=5, pady=5, ipadx=5, ipady=3, sticky=tk.E+tk.W)
 
         self.wantExamples = tk.IntVar()
         self.wantExamples.set(args.examples)
@@ -652,9 +662,21 @@ def init_window(self, args):
         self.wantRunFromRAM.set(args.runFromRAM)
         ttk.Checkbutton(coptionsSubframe, text="Run from RAM", variable=self.wantRunFromRAM).grid(row=0, column=1, padx=4, sticky=tk.W)
 
+        self.wantCPP = tk.IntVar()
+        self.wantCPP.set(args.cpp)
+        ttk.Checkbutton(coptionsSubframe, text="Generate C++", variable=self.wantCPP).grid(row=0, column=3, padx=4, sticky=tk.W)
+
         ttk.Button(coptionsSubframe, text="Advanced...", command=self.config).grid(row=0, column=4, sticky=tk.E)
 
-        optionsRow += 2
+        self.wantCPPExceptions = tk.IntVar()
+        self.wantCPPExceptions.set(args.cppexceptions)
+        ttk.Checkbutton(coptionsSubframe, text="Enable C++ exceptions", variable=self.wantCPPExceptions).grid(row=1, column=0, padx=4, sticky=tk.W)
+
+        self.wantCPPRTTI = tk.IntVar()
+        self.wantCPPRTTI.set(args.cpprtti)
+        ttk.Checkbutton(coptionsSubframe, text="Enable C++ RTTI", variable=self.wantCPPRTTI).grid(row=1, column=1, padx=4, sticky=tk.W)
+
+        optionsRow += 3
 
         # Build Options section
 
@@ -663,14 +685,25 @@ def init_window(self, args):
 
         self.wantBuild = tk.IntVar()
         self.wantBuild.set(args.build)
-        ttk.Checkbutton(boptionsSubframe, text="Run build", variable=self.wantBuild).grid(row=0, column=0, padx=4, sticky=tk.W)
+        ttk.Checkbutton(boptionsSubframe, text="Run build after generation", variable=self.wantBuild).grid(row=0, column=0, padx=4, sticky=tk.W)
 
         self.wantOverwrite = tk.IntVar()
         self.wantOverwrite.set(args.overwrite)
-        ttk.Checkbutton(boptionsSubframe, text="Overwrite project", variable=self.wantOverwrite).grid(row=0, column=1, padx=4, sticky=tk.W)
+        ttk.Checkbutton(boptionsSubframe, text="Overwrite project if it already exists", variable=self.wantOverwrite).grid(row=0, column=1, padx=4, sticky=tk.W)
+
+        optionsRow += 2
+
+        vscodeoptionsSubframe = ttk.LabelFrame(mainFrame, relief=tk.RIDGE, borderwidth=2, text="IDE Options")
+        vscodeoptionsSubframe.grid(row=optionsRow, column=0, columnspan=5, rowspan=2, padx=5, pady=5, ipadx=5, ipady=3, sticky=tk.E+tk.W)
 
         self.wantVSCode = tk.IntVar()
-        ttk.Checkbutton(boptionsSubframe, text="Create VSCode project", variable=self.wantVSCode).grid(row=0, column=2, padx=4, sticky=tk.W)
+        ttk.Checkbutton(vscodeoptionsSubframe, text="Create VSCode project", variable=self.wantVSCode).grid(row=0, column=0, padx=4, sticky=tk.W)
+
+        ttk.Label(vscodeoptionsSubframe, text = "     Debugger:").grid(row=0, column=1, padx=4, sticky=tk.W)
+
+        self.debugger = ttk.Combobox(vscodeoptionsSubframe, values=debugger_list, state="readonly")
+        self.debugger.grid(row=0, column=2, padx=4, sticky=tk.W)
+        self.debugger.current(args.debugger)
 
         optionsRow += 2
 
@@ -712,7 +745,8 @@ def OK(self):
         p = Parameters(sdkPath=self.sdkpath, projectRoot=Path(projectPath), projectName=self.projectName.get(),
                        gui=True, overwrite=self.wantOverwrite.get(), build=self.wantBuild.get(),
                        features=features, projects=projects, configs=self.configs, runFromRAM=self.wantRunFromRAM.get(),
-                       examples=self.wantExamples.get(), uart=self.wantUART.get(), usb=self.wantUSB.get())
+                       examples=self.wantExamples.get(), uart=self.wantUART.get(), usb=self.wantUSB.get(), cpp=self.wantCPP.get(),
+                       debugger=self.debugger.current(), exceptions=self.wantCPPExceptions, rtti=self.wantCPPRTTI)
 
         DoEverything(self, p)
 
@@ -774,14 +808,22 @@ def ParseCommandLine():
     parser.add_argument("-p", "--project", action='append', help="Generate projects files for IDE. Options are: vscode")
     parser.add_argument("-r", "--runFromRAM", action='store_true', help="Run the program from RAM rather than flash")
     parser.add_argument("-uart", "--uart", action='store_true', default=1, help="Console output to UART (default)")
+    parser.add_argument("-nouart", "--nouart", action='store_true', default=0, help="Disable console output to UART")
     parser.add_argument("-usb", "--usb", action='store_true', help="Console output to USB (disables other USB functionality")
+    parser.add_argument("-cpp", "--cpp", action='store_true', default=0, help="Generate C++ code")
+    parser.add_argument("-cpprtti", "--cpprtti", action='store_true', default=0, help="Enable C++ RTTI (Uses more memory)")
+    parser.add_argument("-cppex", "--cppexceptions", action='store_true', default=0, help="Enable C++ exceptions (Uses more memory)")
+    parser.add_argument("-d", "--debugger", type=int, help="Select debugger (0 = SWD, 1 = PicoProbe)", default=0)
 
     return parser.parse_args()
 
 
-def GenerateMain(folder, projectName, features):
+def GenerateMain(folder, projectName, features, cpp):
 
-    filename = Path(folder) / (projectName + '.c')
+    if cpp:
+        filename = Path(folder) / (projectName + '.cpp')
+    else:
+        filename = Path(folder) / (projectName + '.c')
 
     file = open(filename, 'w')
 
@@ -853,7 +895,7 @@ def GenerateCMake(folder, params):
                 )
 
     cmake_header3 = (
-                "# Initialise the Pico SDK\n"
+                "\n# Initialise the Pico SDK\n"
                 "pico_sdk_init()\n\n"
                 "# Add executable. Default name is the project name, version 0.1\n\n"
                 )
@@ -873,7 +915,14 @@ def GenerateCMake(folder, params):
 
     file.write('set(PICO_SDK_PATH ' + p + ')\n\n')
     file.write(cmake_header2)
-    file.write('project(' + params.projectName + ' C CXX ASM)\n\n')
+    file.write('project(' + params.projectName + ' C CXX ASM)\n')
+
+    if params.exceptions:
+        file.write("\nset(PICO_CXX_ENABLE_EXCEPTIONS 1)\n")
+
+    if params.rtti:
+        file.write("\nset(PICO_CXX_ENABLE_RTTI 1)\n")
+
     file.write(cmake_header3)
 
     # add the preprocessor defines for overall configuration
@@ -886,7 +935,11 @@ def GenerateCMake(folder, params):
     # No GUI/command line to set a different executable name at this stage
     executableName = params.projectName
 
-    file.write('add_executable(' + params.projectName + ' ' + params.projectName + '.c )\n\n')
+    if params.wantCPP:
+        file.write('add_executable(' + params.projectName + ' ' + params.projectName + '.cpp )\n\n')
+    else:
+        file.write('add_executable(' + params.projectName + ' ' + params.projectName + '.c )\n\n')
+
     file.write('pico_set_program_name(' + params.projectName + ' "' + executableName + '")\n')
     file.write('pico_set_program_version(' + params.projectName + ' "0.1")\n\n')
 
@@ -925,12 +978,15 @@ def GenerateCMake(folder, params):
 
 
 # Generates the requested project files, if any
-def generateProjectFiles(projectPath, projectName, sdkPath, projects):
+def generateProjectFiles(projectPath, projectName, sdkPath, projects, debugger):
 
     oldCWD = os.getcwd()
 
     os.chdir(projectPath)
 
+    deb = debugger_config_list[debugger]
+
+   # if debugger==0 else 'picoprobe.cfg
     for p in projects :
         if p == 'vscode':
             v1 = ('{\n'
@@ -942,17 +998,23 @@ def generateProjectFiles(projectPath, projectName, sdkPath, projects):
                   '    {\n'
                   '      "name": "Cortex Debug",\n'
                   '      "cwd": "${workspaceRoot}",\n'
-                  '      "executable": "${workspaceRoot}/build/' + projectName + '.elf",\n'
+                  '      "executable": "${command:cmake.launchTargetPath}",\n'
                   '      "request": "launch",\n'
                   '      "type": "cortex-debug",\n'
                   '      "servertype": "openocd",\n'
-                  '      "device": "Pico2040",\n'
+                  '      "gdbPath": "gdb-multiarch",\n'
+                  '      "device": "RP2040",\n'
                   '      "configFiles": [\n' + \
-                  '        "interface/raspberrypi-swd.cfg",\n' + \
+                  '        "interface/' + deb + '",\n' + \
                   '        "target/rp2040.cfg"\n' + \
                   '        ],\n' +  \
-                  '      "svdFile": "' + str(sdkPath) + '/src/rp2040/hardware_regs/rp2040.svd",\n'
+                  '      "svdFile": "${env:PICO_SDK_PATH}/src/rp2040/hardware_regs/rp2040.svd",\n'
                   '      "runToMain": true,\n'
+                  '      // Give restart the same functionality as runToMain\n'
+                  '      "postRestartCommands": [\n'
+                  '          "break main",\n'
+                  '          "continue"\n'
+                  '      ]\n'
                   '    }\n'
                   '  ]\n'
                   '}\n')
@@ -1078,7 +1140,7 @@ def DoEverything(parent, params):
     if params.wantExamples:
         features_and_examples = list(stdlib_examples_list.keys()) + features_and_examples
 
-    GenerateMain('.', params.projectName, features_and_examples)
+    GenerateMain('.', params.projectName, features_and_examples, params.wantCPP)
 
     GenerateCMake('.', params)
 
@@ -1105,7 +1167,7 @@ def DoEverything(parent, params):
         os.system(cmakeCmd)
 
     if params.projects:
-        generateProjectFiles(projectPath, params.projectName, params.sdkPath, params.projects)
+        generateProjectFiles(projectPath, params.projectName, params.sdkPath, params.projects, params.debugger)
 
     if params.wantBuild:
         if params.wantGUI:
@@ -1122,6 +1184,12 @@ def DoEverything(parent, params):
 
 args = ParseCommandLine()
 
+if args.nouart:
+    args.uart = False
+
+#  TODO this could be better, need some constants etc
+if args.debugger > 1:
+    args.debugger = 0
 
 # Check we have everything we need to compile etc
 c = CheckPrerequisites()
@@ -1176,7 +1244,7 @@ def DoEverything(parent, params):
     p = Parameters(sdkPath=sdkPath, projectRoot=projectRoot, projectName=args.name,
                    gui=False, overwrite=args.overwrite, build=args.build, features=args.feature,
                    projects=args.project, configs=(), runFromRAM=args.runFromRAM,
-                   examples=args.examples, uart=args.uart, usb=args.usb)
+                   examples=args.examples, uart=args.uart, usb=args.usb, cpp=args.cpp, debugger=args.debugger, exceptions=args.cppexceptions, rtti=args.cpprtti)
 
     DoEverything(None, p)
 
