How to auto format source file to be EDK2 code style?

How to auto format source file to be EDK2 code style?

[Guoheyi]

Hi folks,


A number of our existing source code files are in really bad format and I'm trying to find a quick way to re-style them. I found the tool called "astyle" almost meets edk2 code style with certain settings, except it will remove the indent before closing parenthesis ")" in a new line. E.g. it will change code like below:

@@ -116,7 +116,7 @@ EhciPciIoPollIo (
   IN  UINT64                       Value,
   IN  UINT64                       Delay,
   OUT UINT64                       *Result
-  )
+)

Any suggestion?

And this is my "astyle" configuration:

#--indent-switches
--indent-cases
--indent-namespaces
--indent-preprocessor
--indent-col1-comments


--pad-oper

--pad-header

--add-brackets
#--pad-comma

--convert-tabs

--indent-classes
--style=1tbs
--indent=spaces=2
--min-conditional-indent=1
--max-instatement-indent=40
--align-pointer=name
--align-reference=name
--max-code-length=80

Thanks and regards,

Gary (Heyi Guo)

Re: How to auto format source file to be EDK2 code style?

[Kinney, Michael D]

Gary,

I have experimented with Astyle too.  The best set of flags I have found so far are:

--style=kr
--indent=spaces=2
--add-brackets
--lineend=windows
--indent-continuation=1
--indent-col1-comments
--pad-oper
--pad-comma
--pad-first-paren-out
--pad-header
--align-pointer=name
--convert-tabs
--max-code-length=120

This gets close, but there are minor issues with

1) Space around '*','&','~','&&','!' operators.
2) Indenting ');' at end of function declaration
3) Aligning arguments and return values in function header comment blocks
4) Aligning arguments in function declarations
5) Aligning local variable declarations.

Mike

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Guoheyi
> Sent: Wednesday, March 22, 2017 7:06 PM
> To: edk2-devel@lists.01.org
> Subject: [edk2] How to auto format source file to be EDK2 code style?
> 
> Hi folks,
> 
> 
> A number of our existing source code files are in really bad format and I'm trying to
> find a quick way to re-style them. I found the tool called "astyle" almost meets edk2
> code style with certain settings, except it will remove the indent before closing
> parenthesis ")" in a new line. E.g. it will change code like below:
> 
> @@ -116,7 +116,7 @@ EhciPciIoPollIo (
>    IN  UINT64                       Value,
>    IN  UINT64                       Delay,
>    OUT UINT64                       *Result
> -  )
> +)
> 
> Any suggestion?
> 
> And this is my "astyle" configuration:
> 
> #--indent-switches
> --indent-cases
> --indent-namespaces
> --indent-preprocessor
> --indent-col1-comments
> 
> 
> --pad-oper
> 
> --pad-header
> 
> --add-brackets
> #--pad-comma
> 
> --convert-tabs
> 
> --indent-classes
> --style=1tbs
> --indent=spaces=2
> --min-conditional-indent=1
> --max-instatement-indent=40
> --align-pointer=name
> --align-reference=name
> --max-code-length=80
> 
> Thanks and regards,
> 
> Gary (Heyi Guo)
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel