Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

alignment and indentation issue with import and "=" for localparam #1272

Open
veripoolbot opened this issue Feb 1, 2018 · 3 comments
Open

alignment and indentation issue with import and "=" for localparam #1272

veripoolbot opened this issue Feb 1, 2018 · 3 comments
Labels
indents

Comments

@veripoolbot
Copy link
Collaborator

Author Name: Enzo Chi
Original Redmine Issue: 1272 from https://www.veripool.org

I am using verilog-mode from commit "c579c46" and set "verilog-auto-lineup" to "all"

Example code:

module alignment_test
import bar_pkg::*;
     import foo_pkg::*;
     #(
       parameter DATA_WIDTH = 8,
       parameter ADDR_WIDTH = 4
       )
     (
      input wire                  clk,
      input wire                  res_n,
      input wire                  valid,
      input wire [DATA_WIDHT-1:0] data_in,
      input wire [ADDR_WIDTH-1:0] addr,
      output logic                accept
      );

     localparam LP_BAR_0 = 1;
     localparam LP_BAR_100 = 100;
     localparam logic [3:0]       LP_BAR_5 = 5;

endmodule
  1. The first "import" right after the module name is not indent and not aligned with the second one.
  2. The local parameter names are not aligned.
  3. The "=" of local parameters are not aligned.
  4. It looks like the LP_BAR_5 is tried to aligned with the port list. What I think the aligned should be inside scope: {}, (), begin/end, etc

Here is the expected code:

module alignment_test
     import bar_pkg::*;
     import foo_pkg::*;
     #(
         parameter DATA_WIDTH = 8,
         parameter ADDR_WIDTH = 4
     )
     (
         input wire                  clk,
         input wire                  res_n,
         input wire                  valid,
         input wire [DATA_WIDHT-1:0] data_in,
         input wire [ADDR_WIDTH-1:0] addr,
         output logic                accept
      );

     localparam             LP_BAR_0   = 1;
     localparam             LP_BAR_100 = 100;
     localparam logic [3:0] LP_BAR_5   = 5;

endmodule
@veripoolbot
Copy link
Collaborator Author

Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2018-02-02T00:30:47Z

I agree this isn't what's expected. Please note the indent code is mostly fixed by contributions, so there may be a long wait for a fix unless you can contribute a parch.

@vinamarora8
Copy link
Contributor

#1683 solves point 2 and 4

This was referenced Aug 9, 2022
Merged
Merged
@gmlarumbe
Copy link
Contributor

From #1800:

Everything indents and aligns correctly except for package imports between module identifier and parameter list. Even though this seems supported by simulators (tested in Xcelium 19.09) I do not think it would be worth the effort looking into it since package importing in the unit space and after ports list already indents correctly.

You could import your packages either in the unit space or after module ports:

import bar_pkg1::*;
import foo_pkg1::*;

module alignment_test
     #(
       parameter DATA_WIDTH = 8,
       parameter ADDR_WIDTH = 4
       )
     (
      input wire                  clk,
      input wire                  res_n,
      input wire                  valid,
      input wire [DATA_WIDHT-1:0] data_in,
      input wire [ADDR_WIDTH-1:0] addr,
      output logic                accept
      );

     import bar_pkg2::*;
     import foo_pkg2::*;

     localparam LP_BAR_0 = 1;
     localparam LP_BAR_100 = 100;
     localparam logic [3:0]       LP_BAR_5 = 5;

endmodule

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
indents
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vinamarora8 @gmlarumbe @veripoolbot