Using RefactorScript to Generate Boilerplate Code

This tutorial shows how to use RefactorScript to automatically generate boilerplate code – repetitive code constructs, such as initialization of all class fields, or printing of their values to a stream.

We will create a simple C++ program that reads rows from a CSV file, sorts them, and outputs the results to stdout. We will manually create a class representing a row and will use RefactorScript to generate the constructor, comparison operator, and the code for printing the field values.

Before you begin, install VisualGDB 5.6 or later and make sure you are using the Custom edition or higher.

  1. Start Visual Studio and launch the VisualGDB Linux Project Wizard:
  2. Enter the name and location for your project:
  3. Press the “Create” button to launch VisualGDB-specific part of the wizard. In this tutorial we will create a new Linux application using the Advanced CMake project subsystem, however RefactorScript will work for any project type that is using Clang IntelliSense:
  4. On the second page of the wizard select the computer and the toolchain that should be used for building the code:
  5. Finally, select how VisualGDB should manage the source files for this project. In this tutorial we will keep them on the Windows side and will upload the changes remotely on each build, however you can also configure VisualGDB to access them directly via SSH:
  6. Press “Finish” to create the project. Once it is created, replace the contents of the main file with the following code:
  7. Add the following data.csv file to your project directory on the Windows machine:

    Then, use VisualGDB Project Properties to create the following upload action:This will upload data.csv to the target directory before debugging the project.
  8. Set a breakpoint in the asm(“nop”) line and make sure the first line of the file was read successfully:
  9. Now we will define a class encapsulating a single data row. Add the following code to the main source file:

    Also, add a vector of the DataRow objects to the main function and update the main loop to add items to it:
  10. This code will not work because DataRow is missing a constructor accepting 3 arguments. We will now use RefactorScript to generate it automatically. Go inside the DataRow struct (make sure the cursor is aligned with the “int” word) and press “Ctrl+.”. Then, select “Run a RefactorScript… -> Generate a constructor“:Note: RefactorScript smart tags are supported starting from Visual Studio 2015. You can run RefactorScript on earlier Visual Studio versions via a button in Code Explorer.
  11. VisualGDB will open the RefactorScript window showing the current context (struct DataRow) and the currently selected script:In this example, the script will work out-of-the-box, generating a constructor. You could also tweak every aspect of the generated code (e.g. decide which parameters to pass by reference) by editing the script. See the RefactorScript reference for a comprehensive description of the RefactorScript language. We will also show a simple custom RefactorScript at the end of this tutorial.
  12. Press “Insert into code” to automatically insert the generated constructor. The code will now work as expected, producing a vector of DataRow instances:
  13. Now we will try sorting the rows. Add the following line to the main() function after the loop:

    Note that it will result in a build error because DataRow does not have a comparison operator:
  14. We will now generate one automatically using RefactorScript. Go back to the DataRow struct, press “Ctrl+.” and select the “Generate comparison operators” script:
  15. This script will also work out-of-the-box . Note that you can select which operators to generate using the “script arguments” section at the top right of the window:
  16. Press Ctrl-Enter to insert the generated operator in the code. The project will now compile and work as expected:
  17. Finally, we will show how to create a simple RefactorScript from scratch. Add the following code to the end of the main() function:

    As before, it will not not compile due to the missing “<<” operator:
  18. To fix the error, add an empty operator before the main() function:

    The code will now build, but won’t output anything yet:
  19. Make sure “DataRow” is selected in the Code Explorer and click the “Run a RefactorScript” button:
  20. Select any of the existing scripts and click “Save as”. Then, pick a new name for your script. In this tutorial, we will call it “GenerateOutputOperator.refscript“:
  21. Replace the contents of the script with the following code:

    It consists of a single generator that accepts an instance of the Record object and outputs a fixed block of code. The “Result” section at the bottom of the window will confirm that it matches the manually created operator:
  22. We will now modify the script to use the real class name instead of hardcoding “DataRow“. Replace “DataRow” with “$class.ShortName” note how the RefactorScript window suggests “ShortName” from the context:
  23. Once you have replaced it, the Result section will immediately reflect this:
  24. Add the following lines inside the main generator:

    Make sure the script still runs without errors:
  25. All we need to do now is to output each field of the class is to add another “>” line inside the foreach block:

    The line will be automatically repeated for each field of the class:
  26. To improve readability, we can print ” ,” after each field except the last one:

  27. One last thing we can do is move the “, ” part on the same line as the field output. To do this, replace the “>”  in the 2 lines within the foreach() loop with “>>”. This will suppress the end-of-line character after them. Add another line at the end of the loop to actually output the semicolon and end of line:

    Now the generated operator contains everything needed to display the field values:
  28. Press “Copy and close” and insert the generated operator in the code. The sorting and outputting of rows will now work as expected:
  29. You can tweak every aspect of the generated code by checking numerous properties of the RefactorScript objects. E.g., you may want to skip static fields, add NULL pointer checks, or output field types along with their values. Use the right side of the RefactorScript window to explore the properties of the objects passed to the script:

You can find the code shown in this tutorial in our tutorial repository on GitHub.

A detailed list of RefactorScripts shipped with VisualGDB, along with sample inputs and outputs is available here.