starred/ngx_waf

Fork 0

mirror of https://github.com/ADD-SP/ngx_waf.git synced 2026-04-26 14:05:52 +03:00

[GH-ISSUE #54] move code from .h to .c #170

New issue

Closed

opened 2026-03-13 16:43:14 +03:00 by kerem · 10 comments

kerem commented

2026-03-13 16:43:14 +03:00

Owner

Originally created by @RekGRpth on GitHub (Jul 22, 2021).
Original GitHub issue: https://github.com/ADD-SP/ngx_waf/issues/54

please, move all code from *.h to *.c

Originally created by @RekGRpth on GitHub (Jul 22, 2021). Original GitHub issue: https://github.com/ADD-SP/ngx_waf/issues/54 please, move all code from *.h to *.c

kerem

2026-03-13 16:43:14 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-03-13 16:43:30 +03:00

Author

Owner

@ADD-SP commented on GitHub (Jul 22, 2021):

Do you mean rename all *.h to *c? I don't know why you would want to do that.

If you mean splitting the headers into .h and .c, then from a software engineering point of view we should do that, but it will cause more warnings and errors when the module is compiled.

To avoid conflicts with other modules or with nginx's own symbols, we develop modules by declaring functions as static, so that symbols inside a source file are not exposed to the outside unless the #include directive is used, and so that symbol conflicts can occur during compilation and linking.

If the declaration is written in *.h and the implementation is written in *.c. then an error will occur at compile time because of the undefined symbols. So I have to put both in one file.

But if you have a way to solve this problem, please advise.

@ADD-SP commented on GitHub (Jul 22, 2021): Do you mean rename all `*.h` to `*c`? I don't know why you would want to do that. If you mean splitting the headers into `.h` and `.c`, then from a software engineering point of view we should do that, but it will cause more warnings and errors when the module is compiled. To avoid conflicts with other modules or with nginx's own symbols, we develop modules by declaring functions as `static`, so that symbols inside a source file are not exposed to the outside unless the `#include` directive is used, and so that symbol conflicts can occur during compilation and linking. If the declaration is written in `*.h` and the implementation is written in `*.c`. then an error will occur at compile time because of the undefined symbols. So I have to put both in one file. But if you have a way to solve this problem, please advise.

kerem commented

2026-03-13 16:43:35 +03:00

Author

Owner

@RekGRpth commented on GitHub (Jul 22, 2021):

Yes, declarations should be in *.h and implementation in *.c

To avoid errors You should does not make static functions that used in many *.c, i.e. if some function is used only in current *.c file then it shuld be static, else - not

@RekGRpth commented on GitHub (Jul 22, 2021): Yes, declarations should be in *.h and implementation in *.c To avoid errors You should does not make static functions that used in many *.c, i.e. if some function is used only in current *.c file then it shuld be static, else - not

kerem commented

2026-03-13 16:43:40 +03:00

Author

Owner

@RekGRpth commented on GitHub (Jul 22, 2021):

Consider static functions as private method and non-static functions as public ones.

And add prefix to all Your public functions with Your unique prefix like ngx_http_waf_ and their names does not conflict with others.

@RekGRpth commented on GitHub (Jul 22, 2021): Consider static functions as private method and non-static functions as public ones. And add prefix to all Your public functions with Your unique prefix like ngx_http_waf_ and their names does not conflict with others.

kerem commented

2026-03-13 16:43:46 +03:00

Author

Owner

@ADD-SP commented on GitHub (Jul 22, 2021):

Consider static functions as private method and non-static functions as public ones.

And add prefix to all Your public functions with Your unique prefix like ngx_http_waf_ and their names does not conflict with others.

I actually considered this way before, but I felt that the code would become more difficult to read (although it is already difficult to read), so I have put it off until now.

@ADD-SP commented on GitHub (Jul 22, 2021): > > > Consider static functions as private method and non-static functions as public ones. > > And add prefix to all Your public functions with Your unique prefix like ngx_http_waf_ and their names does not conflict with others. I actually considered this way before, but I felt that the code would become more difficult to read (although it is already difficult to read), so I have put it off until now.

kerem commented

2026-03-13 16:43:51 +03:00

Author

Owner

@RekGRpth commented on GitHub (Jul 22, 2021):

https://github.com/ADD-SP/ngx_waf is compiled as single *.c file
I found only one project that do so https://github.com/wandenberg/nginx-push-stream-module
but other projects put declarations in *.h and implementation in *.c like https://github.com/nbs-system/naxsi

@RekGRpth commented on GitHub (Jul 22, 2021): https://github.com/ADD-SP/ngx_waf is compiled as single *.c file I found only one project that do so https://github.com/wandenberg/nginx-push-stream-module but other projects put declarations in *.h and implementation in *.c like https://github.com/nbs-system/naxsi

kerem commented

2026-03-13 16:43:56 +03:00

Author

Owner

@ADD-SP commented on GitHub (Jul 22, 2021):

I should not have put this off for so long and I will address it in the near future.

@ADD-SP commented on GitHub (Jul 22, 2021): I should not have put this off for so long and I will address it in the near future.

kerem commented

2026-03-13 16:44:01 +03:00

Author

Owner

@ADD-SP commented on GitHub (Jul 23, 2021):

Done on branch dev.

@ADD-SP commented on GitHub (Jul 23, 2021): Done on branch dev.

kerem commented

2026-03-13 16:44:06 +03:00

Author

Owner

@RekGRpth commented on GitHub (Jul 23, 2021):

thanx, but it does not comile until fix

diff --git a/inc/ngx_http_waf_module_config.h b/inc/ngx_http_waf_module_config.h
index b5740a8..328554b 100644
--- a/inc/ngx_http_waf_module_config.h
+++ b/inc/ngx_http_waf_module_config.h
@@ -11,7 +11,6 @@
 
 #include <string.h>
 #include <utarray.h>
-#include <ngx_cycle.h>
 #include <ngx_http_waf_module_macro.h>
 #include <ngx_http_waf_module_type.h>
 #include <ngx_http_waf_module_util.h>

@RekGRpth commented on GitHub (Jul 23, 2021): thanx, but it does not comile until fix ```diff diff --git a/inc/ngx_http_waf_module_config.h b/inc/ngx_http_waf_module_config.h index b5740a8..328554b 100644 --- a/inc/ngx_http_waf_module_config.h +++ b/inc/ngx_http_waf_module_config.h @@ -11,7 +11,6 @@ #include <string.h> #include <utarray.h> -#include <ngx_cycle.h> #include <ngx_http_waf_module_macro.h> #include <ngx_http_waf_module_type.h> #include <ngx_http_waf_module_util.h> ```

kerem commented

2026-03-13 16:44:11 +03:00

Author

Owner

@ADD-SP commented on GitHub (Jul 23, 2021):

thanx, but it does not comile until fix

diff --git a/inc/ngx_http_waf_module_config.h b/inc/ngx_http_waf_module_config.h
index b5740a8..328554b 100644
--- a/inc/ngx_http_waf_module_config.h
+++ b/inc/ngx_http_waf_module_config.h
@@ -11,7 +11,6 @@
 
 #include <string.h>
 #include <utarray.h>
-#include <ngx_cycle.h>
 #include <ngx_http_waf_module_macro.h>
 #include <ngx_http_waf_module_type.h>
 #include <ngx_http_waf_module_util.h>

Done.

github.com/ADD-SP/ngx_waf@0763c32f86/inc/ngx_http_waf_module_config.h (L12-L22)

@ADD-SP commented on GitHub (Jul 23, 2021): > > > thanx, but it does not comile until fix > > ```diff > diff --git a/inc/ngx_http_waf_module_config.h b/inc/ngx_http_waf_module_config.h > index b5740a8..328554b 100644 > --- a/inc/ngx_http_waf_module_config.h > +++ b/inc/ngx_http_waf_module_config.h > @@ -11,7 +11,6 @@ > > #include <string.h> > #include <utarray.h> > -#include <ngx_cycle.h> > #include <ngx_http_waf_module_macro.h> > #include <ngx_http_waf_module_type.h> > #include <ngx_http_waf_module_util.h> > ``` Done. https://github.com/ADD-SP/ngx_waf/blob/0763c32f861f7e3166955ac5de482ef8fd5e8b7c/inc/ngx_http_waf_module_config.h#L12-L22

kerem commented

2026-03-13 16:44:16 +03:00

Author

Owner

@RekGRpth commented on GitHub (Jul 23, 2021):

thanx, now it compiles!

@RekGRpth commented on GitHub (Jul 23, 2021): thanx, now it compiles!