From adcb93512c2367919b980e1b013c71ba1b7168df Mon Sep 17 00:00:00 2001
From: Paul Licameli <paul.licameli@audacityteam.org>
Date: Fri, 22 Mar 2019 11:01:05 -0400
Subject: [PATCH] Include Audacity.h in all files that test config USE_
 macros...

... except Experimental.h, but see preceding commit.

This is especially important in the header files.

Be sure there are no quiet changes of meaning when a header file is included
in a different context, not having seen Audacity.h.  Rather include Audacity.h
even if redundantly.

Also, in some header files, move more inside the include-guard #ifdef-#endif
pair.
---
 src/MixerBoard.h                 | 1 +
 src/Track.cpp                    | 2 ++
 src/TrackArtist.h                | 1 +
 src/TrackPanel.h                 | 1 +
 src/effects/ChangePitch.h        | 1 +
 src/effects/ChangeTempo.h        | 1 +
 src/effects/SBSMSEffect.h        | 6 ++++--
 src/effects/TimeScale.h          | 8 ++++----
 src/effects/VST/VSTEffect.h      | 2 ++
 src/export/ExportFFmpegDialogs.h | 4 ++--
 src/menus/EditMenus.cpp          | 1 +
 11 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/src/MixerBoard.h b/src/MixerBoard.h
index 41cb8b7f2..020426b6f 100644
--- a/src/MixerBoard.h
+++ b/src/MixerBoard.h
@@ -8,6 +8,7 @@
 
 **********************************************************************/
 
+#include "Audacity.h" // for USE_* macros
 #include "Experimental.h"
 
 #ifndef __AUDACITY_MIXER_BOARD__
diff --git a/src/Track.cpp b/src/Track.cpp
index 80624b8ff..f82204207 100644
--- a/src/Track.cpp
+++ b/src/Track.cpp
@@ -21,6 +21,8 @@ and TimeTrack.
 
 *//*******************************************************************/
 
+#include "Audacity.h" // for USE_* macros
+
 #include "Track.h"
 
 #include "Experimental.h"
diff --git a/src/TrackArtist.h b/src/TrackArtist.h
index 11db6eac5..bce50eb6f 100644
--- a/src/TrackArtist.h
+++ b/src/TrackArtist.h
@@ -18,6 +18,7 @@
 #ifndef __AUDACITY_TRACKARTIST__
 #define __AUDACITY_TRACKARTIST__
 
+#include "Audacity.h" // for USE_* macros
 #include "Experimental.h"
 
 #include "MemoryX.h"
diff --git a/src/TrackPanel.h b/src/TrackPanel.h
index 117e8433a..e2d625037 100644
--- a/src/TrackPanel.h
+++ b/src/TrackPanel.h
@@ -11,6 +11,7 @@
 #ifndef __AUDACITY_TRACK_PANEL__
 #define __AUDACITY_TRACK_PANEL__
 
+#include "Audacity.h" // for USE_* macros
 #include "Experimental.h"
 
 #include "MemoryX.h"
diff --git a/src/effects/ChangePitch.h b/src/effects/ChangePitch.h
index a0673307c..35692e022 100644
--- a/src/effects/ChangePitch.h
+++ b/src/effects/ChangePitch.h
@@ -15,6 +15,7 @@ the pitch without changing the tempo.
 
 *//*******************************************************************/
 
+#include "../Audacity.h" // for USE_* macros
 #if USE_SOUNDTOUCH
 
 #ifndef __AUDACITY_EFFECT_CHANGEPITCH__
diff --git a/src/effects/ChangeTempo.h b/src/effects/ChangeTempo.h
index 46e57bdbd..005d2d400 100644
--- a/src/effects/ChangeTempo.h
+++ b/src/effects/ChangeTempo.h
@@ -11,6 +11,7 @@
 
 **********************************************************************/
 
+#include "Audacity.h" // for USE_* macros
 #if USE_SOUNDTOUCH
 
 #ifndef __AUDACITY_EFFECT_CHANGETEMPO__
diff --git a/src/effects/SBSMSEffect.h b/src/effects/SBSMSEffect.h
index d3181a038..cd000d79b 100644
--- a/src/effects/SBSMSEffect.h
+++ b/src/effects/SBSMSEffect.h
@@ -11,11 +11,13 @@
 
 **********************************************************************/
 
-#if USE_SBSMS
-
 #ifndef __AUDACITY_EFFECT_SBSMS__
 #define __AUDACITY_EFFECT_SBSMS__
 
+#include "../Audacity.h" // for USE_* macros
+
+#if USE_SBSMS
+
 #include "Effect.h"
 #include "../../../lib-src/header-substitutes/sbsms.h"
 
diff --git a/src/effects/TimeScale.h b/src/effects/TimeScale.h
index d7f9cdc07..4608c4645 100644
--- a/src/effects/TimeScale.h
+++ b/src/effects/TimeScale.h
@@ -8,13 +8,13 @@
 
 **********************************************************************/
 
-#include "../Audacity.h"
-
-#if USE_SBSMS
-
 #ifndef __AUDACITY_EFFECT_TIMESCALE__
 #define __AUDACITY_EFFECT_TIMESCALE__
 
+#include "../Audacity.h" // for USE_* macros
+
+#if USE_SBSMS
+
 #include <wx/event.h>
 #include <wx/slider.h>
 #include <wx/string.h>
diff --git a/src/effects/VST/VSTEffect.h b/src/effects/VST/VSTEffect.h
index 2edf8220d..58891527e 100644
--- a/src/effects/VST/VSTEffect.h
+++ b/src/effects/VST/VSTEffect.h
@@ -8,6 +8,8 @@
 
 **********************************************************************/
 
+#include "../../Audacity.h" // for USE_* macros
+
 #if USE_VST
 
 #include <wx/wx.h>
diff --git a/src/export/ExportFFmpegDialogs.h b/src/export/ExportFFmpegDialogs.h
index 06f5e8fd5..680c4275e 100644
--- a/src/export/ExportFFmpegDialogs.h
+++ b/src/export/ExportFFmpegDialogs.h
@@ -11,9 +11,9 @@ LRN
 #if !defined(__EXPORT_FFMPEG_DIALOGS_H__)
 #define __EXPORT_FFMPEG_DIALOGS_H__
 
-#if defined(USE_FFMPEG)
+#include "../Audacity.h"   // keep ffmpeg before wx because they interact // for USE_* macros
 
-#include "../Audacity.h"   // keep ffmpeg before wx because they interact
+#if defined(USE_FFMPEG)
 
 #include "../FFmpeg.h"     // and Audacity.h before FFmpeg for config*.h
 
diff --git a/src/menus/EditMenus.cpp b/src/menus/EditMenus.cpp
index 9fff0107a..d2a9c0a80 100644
--- a/src/menus/EditMenus.cpp
+++ b/src/menus/EditMenus.cpp
@@ -1,3 +1,4 @@
+#include "../Audacity.h" // for USE_* macros
 #include "../AdornedRulerPanel.h"
 #include "../AudacityApp.h" // for EVT_CLIPBOARD_CHANGE
 #include "../LabelTrack.h"