Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prettify instructions for adding a new wxUSE_XXX constant

Browse Source 
Improve translation of the file from plain text to (GitHub-flavoured)
Markdown.
This commit is contained in:
Vadim Zeitlin
2019-01-10 03:44:39 +01:00
parent e90c6e83dd
commit 61b2136bee
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/contributing/how-to-add-new-wxUSE_XXX.md
View File

@@ -1,15 +1,15 @@
How to add a new `wxUSE_XXX` preprocessor constant How to add a new `wxUSE_XXX` preprocessor constant
================================================ ================================================
0. Purpose Purpose
---------- -------
Detailed description of what needs to be done when you want to add a new Detailed description of what needs to be done when you want to add a new
`wxUSE_XXX` compilation flag. The text below assumes you need new `wxUSE_FOO`. `wxUSE_XXX` compilation flag. The text below assumes you need new `wxUSE_FOO`.
1. Overview Overview
----------- --------
wxWidgets uses `wxUSE_XXX` macros for conditionally compiling in (or not) wxWidgets uses `wxUSE_XXX` macros for conditionally compiling in (or not)
optional components. In general, whenever a new non critical (i.e. not optional components. In general, whenever a new non critical (i.e. not
@@ -22,12 +22,12 @@ because then `wxUSE_FOO` would be not defined at all if the user directly
includes wx/foo.h, include "wx/defs.h" before testing for `wxUSE_FOO`. includes wx/foo.h, include "wx/defs.h" before testing for `wxUSE_FOO`.
2. Files to update Files to update
------------------ ---------------
The following files need to be modified when adding a new `wxUSE_FOO`: The following files need to be modified when adding a new `wxUSE_FOO`:
a) include/wx/setup_inc.h - `include/wx/setup_inc.h`
This file contains all common `wxUSE_XXXs`, and is used to update wxMSW, wxMac This file contains all common `wxUSE_XXXs`, and is used to update wxMSW, wxMac
setup.h and Unix setup.h.in using build/update-setup-h. Please try to add setup.h and Unix setup.h.in using build/update-setup-h. Please try to add
@@ -39,13 +39,13 @@ a) include/wx/setup_inc.h
After changing this file, run the update-setup-h script (this is probably After changing this file, run the update-setup-h script (this is probably
better done on a Unix machine although it should work under Cygwin too). better done on a Unix machine although it should work under Cygwin too).
a') include/wx/msw/setup_inc.h for MSW-specific options - `include/wx/msw/setup_inc.h` for MSW-specific options
This file contains MSW-specific options, so if the new option is only used This file contains MSW-specific options, so if the new option is only used
under MSW, add it here instead of include/wx/setup_inc.h. The rest of the under MSW, add it here instead of include/wx/setup_inc.h. The rest of the
instructions is the same as above. instructions is the same as above.
b) include/wx/chkconf.h - `include/wx/chkconf.h`
Add the check for `wxUSE_FOO` definedness in the corresponding (base or GUI) Add the check for `wxUSE_FOO` definedness in the corresponding (base or GUI)
section. Please keep the alphabetic order. section. Please keep the alphabetic order.
@@ -53,35 +53,35 @@ b) include/wx/chkconf.h
If there are any dependencies, i.e. `wxUSE_FOO` requires `wxUSE_BAR` and If there are any dependencies, i.e. `wxUSE_FOO` requires `wxUSE_BAR` and
`wxUSE_BAZ`, check for thme here too. `wxUSE_BAZ`, check for thme here too.
b') include/wx/msw/chkconf.h for MSW-specific options - `include/wx/msw/chkconf.h` for MSW-specific options
These options won't be defined for the other ports, so shouldn't be added to These options won't be defined for the other ports, so shouldn't be added to
the common include/wx/chkconf.h but to this file instead. the common `include/wx/chkconf.h` but to this file instead.
c) configure.in - `configure.in`
Here you need to add `DEFAULT_wxUSE_FOO` define. It should be added in the Here you need to add `DEFAULT_wxUSE_FOO` define. It should be added in the
block beginning after WX_ARG_CACHE_INIT line and should default to "no" for block beginning after `WX_ARG_CACHE_INIT` line and should default to "no" for
"if DEBUG_CONFIGURE = 1" branch (this is used for absolutely minimal builds) `if DEBUG_CONFIGURE = 1` branch (this is used for absolutely minimal builds)
and the same as default value in setup_inc.h in the "else" branch. and the same as default value in `setup_inc.h` in the "else" branch.
You also need to add a WX_ARG_ENABLE (or, if new functionality can be You also need to add a `WX_ARG_ENABLE` (or, if new functionality can be
reasonably described as support for a 3rd party library, WX_ARG_WITH) reasonably described as support for a 3rd party library, `WX_ARG_WITH`)
line togetherw with all the existing WX_ARG_ENABLEs. line together with all the existing `WX_ARG_ENABLE`s.
If you have a sample/foo which should be only built when `wxUSE_FOO==1`, If you have a sample/foo which should be only built when `wxUSE_FOO==1`,
then only add it to the SAMPLES_SUBDIRS if `wxUSE_FOO=yes` in configure. then only add it to the `SAMPLES_SUBDIRS` if `wxUSE_FOO=yes` in configure.
d) build/cmake/options.cmake - `build/cmake/options.cmake`
To include the option in CMake, add a new line in the appropriate To include the option in CMake, add a new line in the appropriate
section of options.cmake. section of `options.cmake`.
wx_option(wxUSE_FOO "enable FOO") wx_option(wxUSE_FOO "enable FOO")
As an optional third parameter you may specify `OFF` when the option As an optional third parameter you may specify `OFF` when the option
should be disabled by default. should be disabled by default.
e) docs/doxygen/mainpages/const_wxusedef.h - `docs/doxygen/mainpages/const_wxusedef.h`
Add a brief description of the new constant. Add a brief description of the new constant.