Merge pull request #938 from Paul-Licameli/New-utility-library

New utility library

libraries/CMakeLists.txt

@@ -5,6 +5,7 @@
 set( LIBRARIES
    "lib-string-utils"
    lib-strings
+   lib-utility
 )
 
 if ( ${_OPT}has_networking )

libraries/lib-utility/CMakeLists.txt

@@ -0,0 +1,25 @@
+#[[
+A small library defining various constants and utilities
+
+No dependencies on wxWidgets.  Very few if any symbols with linkage.
+
+One very important utility is finally() as defined in The C++ Programming
+Language, fourth edition, for describing ad-hoc RAII actions.
+
+Historically, MemoryX.h began as a wrapper of C++11 <memory>, which by itself
+did not yet provide std::make_unique.  That explains the name.
+
+Audacity now uses C++14, and yet, need arose for other anticipations of
+future standards, such as with optional.  It also provides other pervasively
+used utilities that don't correspond to things in the standard.
+
+]]#
+
+set( SOURCES
+   MemoryX.cpp
+   MemoryX.h
+   ModuleConstants.h
+)
+audacity_library( lib-utility "${SOURCES}" ""
+   "" ""
+)

libraries/lib-utility/MemoryX.cpp

@@ -0,0 +1,5 @@
+#include "MemoryX.h"
+
+// Make the symbol table non-empty
+UTILITY_API void lib_utility_dummy_symbol()
+{}

libraries/lib-utility/MemoryX.h

@@ -2,6 +2,7 @@
 #define __AUDACITY_MEMORY_X_H__
 
 // C++ standard header <memory> with a few extensions
+#include <iterator>
 #include <memory>
 #include <cstdlib> // Needed for free.
 #ifndef safenew
@@ -10,64 +11,6 @@
 
 #include <functional>
 
-#if !(_MSC_VER >= 1800 || __cplusplus >= 201402L)
-/* replicate the very useful C++14 make_unique for those build environments
-that don't implement it yet.
-typical usage:
-auto p = std::make_unique<Myclass>(ctorArg1, ctorArg2, ... ctorArgN);
-p->DoSomething();
-auto q = std::make_unique<Myclass[]>(count);
-q[0].DoSomethingElse();
-
-The first hides naked NEW and DELETE from the source code.
-The second hides NEW[] and DELETE[].  Both of course ensure destruction if
-you don't use something like std::move(p) or q.release().  Both expressions require
-that you identify the type only once, which is brief and less error prone.
-
-(Whereas this omission of [] might invite a runtime error:
-std::unique_ptr<Myclass> q { safenew Myclass[count] }; )
-
-Some C++11 tricks needed here are (1) variadic argument lists and
-(2) making the compile-time dispatch work correctly.  You can't have
-a partially specialized template function, but you get the effect of that
-by other metaprogramming means.
-*/
-
-namespace std {
-   // For overloading resolution
-   template <typename X> struct __make_unique_result {
-      using scalar_case = unique_ptr<X>;
-   };
-
-   // Partial specialization of the struct for array case
-   template <typename X> struct __make_unique_result<X[]> {
-      using array_case = unique_ptr<X[]>;
-      using element = X;
-   };
-
-   // Now the scalar version of unique_ptr
-   template<typename X, typename... Args> inline
-      typename __make_unique_result<X>::scalar_case
-      make_unique(Args&&... args)
-   {
-      return typename __make_unique_result<X>::scalar_case
-      { safenew X(forward<Args>(args)...) };
-   }
-
-   // Now the array version of unique_ptr
-   // The compile-time dispatch trick is that the non-existence
-   // of the scalar_case type makes the above overload
-   // unavailable when the template parameter is explicit
-   template<typename X> inline
-      typename __make_unique_result<X>::array_case
-      make_unique(size_t count)
-   {
-      return typename __make_unique_result<X>::array_case
-      { safenew typename __make_unique_result<X>::element[count] };
-   }
-}
-#endif
-
 /*
  * ArrayOf<X>
  * Not to be confused with std::array (which takes a fixed size) or std::vector
@@ -195,17 +138,6 @@ public:
   with *, ->, reset(), or in if()
  */
 
-// Placement-NEW is used below, and that does not cooperate with the DEBUG_NEW for Visual Studio
-#ifdef _DEBUG
-#ifdef _MSC_VER
-#undef new
-
-// wx/any.h also uses Placement-NEW so include it before redefining "new" at comment:
-//    "Restore definition of debug new"
-#include <wx/any.h>
-#endif
-#endif
-
 template<typename X>
 class Optional {
 public:
@@ -322,15 +254,6 @@ private:
    X* pp{ nullptr };
 };
 
-// Restore definition of debug new
-#ifdef _DEBUG
-#ifdef _MSC_VER
-#undef THIS_FILE
-static const char THIS_FILE[] = __FILE__;
-#define new new(_NORMAL_BLOCK, THIS_FILE, __LINE__)
-#endif
-#endif
-
 /**
   A deleter for pointers obtained with malloc
  */
@@ -387,7 +310,6 @@ Final_action<F> finally (F f)
    return Final_action<F>(f);
 }
 
-#include <wx/utils.h> // for wxMin, wxMax
 #include <algorithm>
 
 /**

src/AudacityApp.h

@@ -22,7 +22,7 @@
 #include <wx/app.h> // to inherit
 #include <wx/timer.h> // member variable
 
-#include "MemoryX.h"
+#include <memory>
 
 class wxSingleInstanceChecker;
 class wxSocketEvent;

src/AudioIOBase.cpp

@@ -17,6 +17,7 @@ Paul Licameli split from AudioIO.cpp
 #include <wx/sstream.h>
 #include <wx/txtstrm.h>
 
+#include "MemoryX.h"
 #include "Prefs.h"
 #include "widgets/MeterPanelBase.h"
 

src/CMakeLists.txt

@@ -180,14 +180,12 @@ list( APPEND SOURCES
       MacroMagic.h
       Matrix.cpp
       Matrix.h
-      MemoryX.h
       Menus.cpp
       Menus.h
       Mix.cpp
       Mix.h
       MixerBoard.cpp
       MixerBoard.h
-      ModuleConstants.h
       ModuleManager.cpp
       ModuleManager.h
       ModuleSettings.cpp

src/DeviceChange.h

@@ -17,7 +17,7 @@
 
 #if defined(EXPERIMENTAL_DEVICE_CHANGE_HANDLER)
 
-#include "MemoryX.h"
+#include <memory>
 
 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(HAVE_LIBUDEV_H)
 #define HAVE_DEVICE_CHANGE

src/FileFormats.cpp

@@ -22,6 +22,7 @@ information.
 #include <wx/intl.h>
 #include "sndfile.h"
 #include "Internat.h"
+#include "MemoryX.h"
 #include "widgets/AudacityMessageBox.h"
 #include "Prefs.h"
 

src/FileFormats.h

@@ -17,7 +17,7 @@
 #include "Identifier.h"
 
 //#include <mutex>
-#include "MemoryX.h"
+#include <memory>
 
 #include "sndfile.h"
 

src/FileIO.h

@@ -11,7 +11,7 @@
 #ifndef __AUDACITY_FILEIO__
 #define __AUDACITY_FILEIO__
 
-#include "MemoryX.h"
+#include <memory>
 
 class wxInputStream;
 class wxOutputStream;

src/FileNames.cpp

@@ -25,7 +25,7 @@ used throughout Audacity into this one place.
 
 
 
-#include "MemoryX.h"
+#include <memory>
 
 #include <wx/app.h>
 #include <wx/defs.h>

src/FileNames.h

@@ -17,7 +17,7 @@
 #include <wx/string.h> // function return value
 #include "Identifier.h"
 #include "Prefs.h"
-#include "MemoryX.h"
+#include <memory>
 
 // Please try to support unlimited path length instead of using PLATFORM_MAX_PATH!
 // Define one constant for maximum path value, so we don't have to do

src/HitTestResult.h

@@ -11,7 +11,7 @@ Paul Licameli
 #ifndef __AUDACITY_HIT_TEST_RESULT__
 #define __AUDACITY_HIT_TEST_RESULT__
 
-#include "MemoryX.h"
+#include <memory>
 #include "Internat.h" // for TranslatableString
 
 class wxCursor;

src/ImageManipulation.h

@@ -8,11 +8,12 @@
 
 **********************************************************************/
 
-#include "MemoryX.h"
+#include <memory>
 #include <wx/defs.h>
 
 class wxColour;
 class wxImage;
+class wxRect;
 
 // This looks at the first pixel in the image, and shifts
 // the entire image by the vector difference between that

src/ModuleManager.cpp

@@ -30,6 +30,7 @@ i.e. an alternative to the usual interface, for Audacity.
 #include <wx/filename.h>
 
 #include "FileNames.h"
+#include "MemoryX.h"
 #include "PluginManager.h"
 
 #include "audacity/PluginInterface.h"

src/ModuleManager.h

@@ -12,7 +12,7 @@
 #ifndef __AUDACITY_MODULEMANAGER_H__
 #define __AUDACITY_MODULEMANAGER_H__
 
-#include "MemoryX.h"
+#include <memory>
 #include <map>
 #include <vector>
 
@@ -23,6 +23,7 @@ class wxArrayString;
 class wxDynamicLibrary;
 class ComponentInterface;
 class ModuleInterface;
+class wxWindow;
 
 //
 // Module Manager

src/Prefs.cpp

@@ -61,6 +61,7 @@
 
 #include "Internat.h"
 #include "MemoryX.h"
+#include <memory>
 
 std::unique_ptr<FileConfig> ugPrefs {};
 

src/Registrar.h

@@ -22,7 +22,7 @@ responsible for calling the appropriate callback functions.
 
 
 
-#include "MemoryX.h"
+#include <memory>
 
 class AudacityCommand;
 class LoadableModule;

src/SelectionState.h

@@ -14,7 +14,7 @@ class Track;
 class TrackList;
 class ViewInfo;
 #include "ClientData.h"
-#include "MemoryX.h"
+#include <memory>
 #include <vector>
 
 // State relating to the set of selected tracks

src/Theme.cpp

@@ -77,6 +77,7 @@ can't be.
 #include "Prefs.h"
 #include "ImageManipulation.h"
 #include "Internat.h"
+#include "MemoryX.h"
 #include "widgets/AudacityMessageBox.h"
 
 // JKC: First get the MAC specific images.

src/TrackPanelCell.h

@@ -13,7 +13,7 @@ Paul Licameli
 
 
 
-#include "MemoryX.h"
+#include <memory>
 #include "TrackPanelDrawable.h" // to inherit
 
 class AudacityProject;

src/TrackPanelDrawingContext.h

@@ -11,7 +11,7 @@
 #ifndef __AUDACITY_TRACK_PANEL_DRAWING_CONTEXT__
 #define __AUDACITY_TRACK_PANEL_DRAWING_CONTEXT__
 
-#include "MemoryX.h"
+#include <memory>
 
 class UIHandle;
 using UIHandlePtr = std::shared_ptr<UIHandle>;

src/TrackPanelMouseEvent.h

@@ -16,7 +16,7 @@ class wxMouseState;
 class wxRect;
 class wxSize;
 class TrackPanelCell;
-#include "MemoryX.h"
+#include <memory>
 
 // This is a hack so that the code that fakes a MOUSE_LEFT_BTN_UP on
 // capture lost doesn't get in the way of handling MOUSE_RIGHT_BTN_UP.

src/UIHandle.h

@@ -12,7 +12,7 @@ Paul Licameli
 #define __AUDACITY_UI_HANDLE__
 
 #include <utility>
-#include "MemoryX.h"
+#include <memory>
 #include "TrackPanelDrawable.h" // to inherit
 
 class wxDC;
@@ -26,8 +26,6 @@ class TrackPanelCell;
 struct TrackPanelMouseEvent;
 struct TrackPanelMouseState;
 
-#include "MemoryX.h"
-
 /// \brief Short-lived drawing and event-handling object associated with a TrackPanelCell
 // A TrackPanelCell reports a handle object of some subclass, in response to a
 // hit test at a mouse position; then this handle processes certain events,

src/ViewInfo.h

@@ -16,7 +16,7 @@
 #include <wx/event.h> // inherit wxEvtHandler
 #include <wx/weakref.h> // member variable
 #include "SelectedRegion.h"
-#include "MemoryX.h"
+#include <memory>
 #include "ZoomInfo.h" // to inherit
 
 

src/commands/AppCommandEvent.h

@@ -19,7 +19,7 @@
 
 
 #include <wx/event.h> // to declare custom event types
-#include "../MemoryX.h"
+#include <memory>
 
 DECLARE_EXPORTED_EVENT_TYPE(AUDACITY_DLL_API, wxEVT_APP_COMMAND_RECEIVED, -1);
 

src/commands/CommandBuilder.h

@@ -16,7 +16,8 @@
 #ifndef __COMMANDBUILDER__
 #define __COMMANDBUILDER__
 
-#include "../MemoryX.h"
+#include <memory>
+#include <wx/string.h>
 
 class AudacityProject;
 class ResponseTarget;

src/commands/CommandHandler.h

@@ -16,7 +16,7 @@
 #ifndef __COMMANDHANDLER__
 #define __COMMANDHANDLER__
 
-#include "../MemoryX.h"
+#include <memory>
 class AudacityApp;
 class AudacityProject;
 class AppCommandEvent;

src/commands/CommandTargets.h

@@ -55,8 +55,9 @@ and sends it to that message target.
 #ifndef __COMMANDTARGETS__
 #define __COMMANDTARGETS__
 
-#include "../MemoryX.h"
+#include <memory>
 #include <vector>
+#include <wx/string.h>
 #include <wx/thread.h>
 
 class wxStatusBar;

src/commands/LoadCommands.h

@@ -17,7 +17,7 @@
 #include <functional>
 #include <memory>
 #include <unordered_map>
-#include "../MemoryX.h"
+#include <memory>
 
 class AudacityCommand;
 

src/commands/ScriptCommandRelay.h

@@ -18,7 +18,7 @@
 
 
 
-#include "../MemoryX.h"
+#include <memory>
 
 class wxString;
 

src/commands/Validators.h

@@ -45,7 +45,7 @@ a certain criterion. This is a base validator which allows anything.
 
 class wxArrayString;
 
-#include "../MemoryX.h"
+#include "MemoryX.h"
 
 #include <wx/variant.h> // member variable
 

src/effects/Biquad.cpp

@@ -12,6 +12,7 @@ Max Maisel
 #include "Biquad.h"
 
 #include <cmath>
+#include <wx/utils.h>
 
 #define square(a) ((a)*(a))
 #define PI M_PI

src/effects/EBUR128.h

@@ -12,9 +12,11 @@ Max Maisel
 #define __EBUR128_H__
 
 #include "Biquad.h"
-#include "MemoryX.h"
+#include <memory>
 #include "SampleFormat.h"
 
+#include <cmath>
+
 /// \brief Implements EBU-R128 loudness measurement.
 class EBUR128
 {

src/effects/Equalization48x.h

@@ -13,7 +13,7 @@ Intrinsics (SSE/AVX) and Threaded Equalization
 
 #ifdef EXPERIMENTAL_EQ_SSE_THREADED
 
-#include "../MemoryX.h"
+#include <memory>
 
 #include <wx/thread.h> // to inherit
 #include <audacity/Types.h>

src/effects/LoadEffects.h

@@ -16,7 +16,7 @@
 #include <functional>
 #include <memory>
 #include <unordered_map>
-#include "../MemoryX.h"
+#include <memory>
 
 class Effect;
 

src/effects/RealtimeEffectManager.cpp

@@ -12,7 +12,7 @@
 #include "RealtimeEffectManager.h"
 
 #include "audacity/EffectInterface.h"
-#include "MemoryX.h"
+#include <memory>
 
 #include <atomic>
 #include <wx/time.h>

src/effects/TimeWarper.cpp

@@ -20,6 +20,7 @@ Geometric TimeWarper classes
 
 #include <wx/string.h>
 #include <math.h>
+#include <wx/debug.h>
 
 TimeWarper::~TimeWarper() = default;
 

src/effects/TimeWarper.h

@@ -56,7 +56,7 @@ of the warped region.
 #ifndef __TIMEWARPER__
 #define __TIMEWARPER__
 
-#include "../MemoryX.h"
+#include <memory>
 
 class AUDACITY_DLL_API TimeWarper /* not final */
 {

src/effects/VST/VSTControlOSX.mm

@@ -24,7 +24,7 @@
 
 #include "VSTControlOSX.h"
 
-#include "../../MemoryX.h"
+#include <memory>
 
 @interface VSTView : NSView
 {

src/effects/audiounits/AUControl.mm

@@ -31,7 +31,7 @@
 #include <AudioUnit/AudioUnitCarbonView.h>
 #endif
 
-#include "../../MemoryX.h"
+#include "MemoryX.h"
 
 @interface AUView : NSView
 {

src/effects/audiounits/AudioUnitEffect.h

@@ -14,7 +14,7 @@
 
 #if USE_AUDIO_UNITS
 
-#include "../../MemoryX.h"
+#include "MemoryX.h"
 #include <vector>
 
 #include <AudioToolbox/AudioUnitUtilities.h>

src/effects/lv2/LoadLV2.h

@@ -12,7 +12,7 @@
 #ifndef LV2EFFECTSMODULE_H
 #define LV2EFFECTSMODULE_H
 
-#include "../../MemoryX.h"
+#include <memory>
 
 #include "lilv/lilv.h"
 

src/export/ExportMP3.h

@@ -13,7 +13,7 @@
 
 /* --------------------------------------------------------------------------*/
 
-#include "../MemoryX.h"
+#include <memory>
 
 enum MP3RateMode : unsigned {
    MODE_SET = 0,

src/import/ImportForwards.h

@@ -10,7 +10,7 @@
 #define __AUDACITY_IMPORT_FORWARDS__
 
 #include <vector>
-#include "../MemoryX.h"
+#include <memory>
 
 class ImportPlugin;
 class UnusableImportPlugin;

src/import/ImportRaw.h

@@ -11,7 +11,7 @@
 #ifndef __AUDACITY_IMPORT_RAW__
 #define __AUDACITY_IMPORT_RAW__
 
-#include "../MemoryX.h"
+#include <memory>
 
 class AudacityProject;
 class WaveTrackFactory;

src/toolbars/ToolDock.h

@@ -17,6 +17,7 @@
 #include <wx/defs.h>
 
 #include "ToolBar.h"
+#include "MemoryX.h"
 
 class wxCommandEvent;
 class wxEraseEvent;

src/tracks/ui/PlayIndicatorOverlay.h

@@ -12,7 +12,7 @@ Paul Licameli split from TrackPanel.cpp
 #define __AUDACITY_PLAY_INDICATOR_OVERLAY__
 
 #include <wx/event.h> // to inherit
-#include "../../MemoryX.h"
+#include <memory>
 #include "../../ClientData.h"
 #include "../../widgets/Overlay.h" // to inherit
 

src/tracks/ui/SliderHandle.h

@@ -14,6 +14,7 @@ Paul Licameli
 #include "../../UIHandle.h"
 
 class wxMouseEvent;
+class wxMouseState;
 class LWSlider;
 class Track;
 class TranslatableString;

src/widgets/Grid.cpp

@@ -27,6 +27,7 @@
 #include <wx/settings.h>
 #include <wx/toplevel.h>
 
+#include "MemoryX.h"
 #include "../SelectedRegion.h"
 
 #if wxUSE_ACCESSIBILITY

src/widgets/NumericTextCtrl.h

@@ -17,7 +17,7 @@
 
 
 
-#include "../MemoryX.h"
+#include <memory>
 #include "../../include/audacity/ComponentInterface.h"
 #include <vector>
 #include <wx/setup.h> // for wxUSE_* macros

src/widgets/OverlayPanel.cpp

@@ -10,6 +10,7 @@
 #include "OverlayPanel.h"
 
 #include "Overlay.h"
+#include "MemoryX.h"
 #include <algorithm>
 #include <wx/dcclient.h>
 

src/widgets/PopupMenuTable.h

@@ -23,7 +23,7 @@ class wxCommandEvent;
 #include <functional>
 #include <vector>
 #include <wx/menu.h> // to inherit wxMenu
-#include "../MemoryX.h"
+#include <memory>
 
 #include "Internat.h"
 #include "../commands/CommandManager.h"

src/widgets/valnum.h

@@ -11,7 +11,7 @@
 #ifndef _WIDGETS_VALNUM_H_
 #define _WIDGETS_VALNUM_H_
 
-#include "../MemoryX.h"
+#include <memory>
 #include <wx/setup.h> // for wxUSE_* macros
 #include <wx/defs.h>
 

src/widgets/wxPanelWrapper.h

@@ -9,7 +9,7 @@
 #ifndef __AUDACITY_WXPANEL_WRAPPER__
 #define __AUDACITY_WXPANEL_WRAPPER__
 
-#include "../MemoryX.h"
+#include <memory>
 #include <wx/panel.h> // to inherit
 #include <wx/dialog.h> // to inherit