[VeriblePreProcessor][4]: Handling file inclusion in "VerilogPreprocess" class.

[karimtera]

NOTE: This is a part of the sequentially splitted PRs from PR #1360.

Description:

• Added a feature to VerilogPreprocess which allows to store paths,
  That can be used later to find the SV file to include.
• The preprocessor tool takes these paths from the user,
  as a +incdir+<path>[+<another_path>] and set them in VerilogPreprocess.
• The included files macros and conditionals can be expanded and evaluated.
• Some limitations exists and were written as TODOs in place,
  need to open issues for these.

[hzeller]

Let's await until we're done with the other PRs, to not have too many review comments going on in parallel that might be harder to merge later.
With regard to include files it might be worthwhile looking around what happens in the context of the verilog project supprt verilog/analysis/verilog_project.h which is used by the Kythe indexer and the symbol table.

Not everything might apply, but it is good to have a look to have an informed choice knowing what already exists and could be re-used.

[karimtera]

I will start by replacing both of these functions with SetFileList().

[karimtera]

This should be the FileList containing defines, incdirs and SystemVerilog files.

A question: The SystemVerilog files will not be needed here, is there a way to make use of it? or remove it?

[hzeller]

We can change everything as needed.
Maybe we have a sub-type in FileList that contain preprocessing information.

struct FileList {
   struct PreprocessingInfo {
         std::vector<std::string> include_dirs;
         // ... macro defintions
   };
   std::vector<std::string> file_paths;
   PreprocessingInfo preprocessing;
};

Then use that type with only the relevant parts:

   FileList::PreprocessingInfo

Might need to change all the places the current FileList is used, but it is worthwhile to improve clarity.

[karimtera]

There is a cycle in dependency problem whenever I try to include verilog_project.h in verilog_preprocess.h, because the former includes verilog_analyzer.h, which also includes verilog_preprocess.h.

Would it be a good idea if I isolate the definition of the FileList in a separte file?

[hzeller]

Sounds good. Put FileList in a separate file.

[hzeller]

Do you want to rebase this one or create a fresh new one as it might be easier ?

[karimtera]

I will create a fresh branch for this.

[karimtera]

Closed by #1482