Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/04/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.30.14. qed::find_projects_under_directory (::quartus::qed)

The following table displays information for the qed::find_projects_under_directory Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::find_projects_under_directory [-h | -help] [-long_help] [-project_match <project_match> ] [-directory_match <directory_match> ] [-include_all_revisions] <search_dir>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-project_match <project_match> Pattern to match against the QPF file basenames
-directory_match <directory_match> Pattern to match against the QPF file directories
-include_all_revisions Flag to return all revisions of detected projects instead of the first
<search_dir> Directory to search
Description
Recursively searches a directory for Quartus Prime Pro projects
and returns a list of Tcl dicts, where each dict contains
metadata about the projects that were found. The metadata is
typically used when you add projects to the workspace.

If no Quartus Prime Pro projects are found, the command returns an empty
list.

A Quartus Prime Pro project is considered to be a file with a .qpf
extension.

The "-project_match" and "-directory_match" options use Tcl glob-style
name matching semantics. Supported wildcard characters include * and ?.
The default value of the "-project_match" and "-directory_match"
options is *.

The command recursively finds all files with names matching *.qpf,
starting in the directory specified with the "-search_dir" option.
You must specify a directory with the "-search_dir" option, even
if it is "." (the current directory); there is no default value.
The command applies the directory_match wildcard to the name of each
directory containing a .qpf file, and it applies the project_match
wildcard to the file name of the .qpf file.

The command extracts metadata for any Quartus Prime Pro projects that
match the "-project_match" and "-directory_match" options. If you
specify the "-include_all_revisions" option, metadata is extracted for
all revisions of each project. If you do not specify the option,
metadata is extracted for only the active revision of each project.

The dict that is returned for each project includes the following
properties: qpf_path is the absolute path of the Quartus Prime Pro project
file, revision is the name of the project revision, version is the
version of the Quartus Prime Pro software last used to open the project,
and id is an automatically-generated unique name for the combination
of that project and revision.
Example Usage
    qed::find_projects_under_directory "."
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful