A List of Widgets Required

[tangxifan]

Is your feature request related to a problem? Please describe. As seen in PR https://github.com/os-fpga/FOEDAG/pull/35, the main window has been created. I have learned from Qt online documentation: https://doc.qt.io/qt-5/qtwidgets-index.html As the Qt framework is modularized, the main window will finally be a place where all the widgets are added. Each widget will be an independent class inherit from Qt classes, e.g., QDockWidget, QApplication etc. Therefore, it is time to split our workload and parallelize the effort.

Describe the solution you'd like

Work plan

I propose that we work in this style

• Define the list of Widgets to be created
• Each team member claims the Widget to work on
• We keep a track on the progress of each Widget. One Widget -> one or more pull requests

List of Widgets

Here, I only list the minimum Widgets required to build a mini FPGA IDE Each widget can be in a separated issue

• Console which includes
  • A text box where Tcl command can be typed in
  • A label box where all the logs can be shown
  • A filter to display only errors and warnings
• Flow navigator which includes
  • A QTreeWidget which show steps required to perform a complete design flow
  • (Optional) Progress bars to show success and failures of each step
  • Right click to open any log files outputted by each step
  • Text Editor which supports
  • TextBox to load and write HDL codes from/to files
  • HDL syntax highlight and error indicator
  • Multi-tab to open multiple files
  • Project navigator which shows
  • Project settings
  • Source file categories and hierarchies
• New project wizard
  • Select device/board from a list
  • Select source files/design constraints
  • Create project description file
• New file wizard
  • Select the file types
  • Use QFileDialog as the base
• I/O plan wizard
  • Select the I/O plan from figures
  • Output I/O constraints to files
• Timing analysis stats
  • Show bar graph on the slack/path delay distribution on all the paths

[tangxifan]

@MidsummerNight @alain-rs @liibin

Feel free to comment and add new Widgets. Open to discussion here

[liibin]

About the editor, I found an open source editor Qsciscintila

Can we use it.

[tangxifan]

About the editor, I found an open source editor Qsciscintila

Can we use it.

I just see they use a mix of GPL and commercial

QScintilla is available under the GNU General Public License v3 and the Riverbank Commercial License.

If you go for commercial, you may have to buy licenses. It will turn our project into GPL license.

[MidsummerNight]

Just a heads up, I have a couple of priorities to sort out at my commpany before I can really work on this full-time. I'll follow as closely as I can, but at least for the next 2 or 3 months @liibin will be the major GUI dev on our side.

[tangxifan]

After a discussion with the team, the Widget workload is now splitted between groups

• Console [@tangxifan @alain-rs]
• Flow navigator [@tangxifan @alain-rs ]
• Text editor [@MidsummerNight @liibin ]
• Project navigator [@MidsummerNight @liibin ]
• New project wizard [@MidsummerNight @liibin ]
• New file wizard [@MidsummerNight @liibin ]
• I/O planner [ to be discussed ]
• Timing analysis stats [not urgent for now; Still on roadmap; Will continue after high-priority widgets are finished]

[tangxifan]

Let me know if this works fine for you @alain-rs @MidsummerNight @liibin We can start working in parallel.

The first thing we should do is to create specification for each widget (can be slide only)

• Specification includes
  • Widget window floorplanning
  • Input&output file formats
  • Tcl commands
• Each widget should have a dedicated issue opened, where specification is uploaded
• All the teams should agree on specifications and then we can start coding