From e1b60916b790ec05dd30089ace7039d94cac3fdb Mon Sep 17 00:00:00 2001 From: Paul Licameli Date: Tue, 27 Mar 2018 14:17:23 -0400 Subject: [PATCH] More consistent naming conventions for choice control items... ... This commit leaves at least a comment for all choice controls of all built-in effects and commands. Use CamelCase with no spaces for the internal identifiers, given in wxT("...") Use more idiomatic English with spaces in the user-visible names, given in XO("..."); these strings go to the message catalog for internationalization Do not use underscores In case these strings are the same, give it just once in XO("..."), but if in a future version it is decided to change the name in XO("..."), then the original should be kept also in a distinct wxT("...") string, so that saved configuration or plugin settings or macro files don't become gratuitously incompatible just because of that user-visible name change. Left TruncateSilence alone for now -- I think that choice demands a rewrite as a slider instead. --- src/commands/DragCommand.cpp | 6 +++--- src/commands/GetInfoCommand.cpp | 6 +++++- src/commands/ScreenshotCommand.cpp | 29 ++++++++++++++-------------- src/commands/SelectCommand.cpp | 10 ++++++---- src/commands/SetClipCommand.cpp | 8 ++++---- src/commands/SetTrackInfoCommand.cpp | 13 ++++++++----- src/effects/Distortion.cpp | 20 +++++++++---------- src/effects/Equalization.cpp | 2 ++ src/effects/Noise.cpp | 1 + src/effects/ScienFilter.cpp | 5 +++-- src/effects/ToneGen.cpp | 3 ++- src/effects/TruncSilence.cpp | 6 ++++-- 12 files changed, 63 insertions(+), 46 deletions(-) diff --git a/src/commands/DragCommand.cpp b/src/commands/DragCommand.cpp index 163aa267d..129e0a7b6 100644 --- a/src/commands/DragCommand.cpp +++ b/src/commands/DragCommand.cpp @@ -41,9 +41,9 @@ enum kCoordTypes static const IdentInterfaceSymbol kCoordTypeStrings[nCoordTypes] = { { XO("Panel") }, - { XO("App") }, - { XO("Track0") }, - { XO("Track1") }, + { wxT("App"), XO("Application") }, + { wxT("Track0"), XO("Track 0") }, + { wxT("Track1"), XO("Track 1") }, }; diff --git a/src/commands/GetInfoCommand.cpp b/src/commands/GetInfoCommand.cpp index 16bfc4594..8f6a60bd8 100644 --- a/src/commands/GetInfoCommand.cpp +++ b/src/commands/GetInfoCommand.cpp @@ -58,7 +58,7 @@ enum { static const IdentInterfaceSymbol kTypes[nTypes] = { { XO("Commands") }, - { XO("Commands+") }, + { wxT("CommandsPlus"), XO("Commands Plus") }, { XO("Menus") }, { XO("Preferences") }, { XO("Tracks") }, @@ -77,7 +77,11 @@ enum { static const IdentInterfaceSymbol kFormats[nFormats] = { + // These are acceptable dual purpose internal/visible names + + /* i18n-hint JavaScript Object Notation */ { XO("JSON") }, + /* i18n-hint name of a computer programming language */ { XO("LISP") }, { XO("Brief") } }; diff --git a/src/commands/ScreenshotCommand.cpp b/src/commands/ScreenshotCommand.cpp index 7843cd264..bdfed1c45 100644 --- a/src/commands/ScreenshotCommand.cpp +++ b/src/commands/ScreenshotCommand.cpp @@ -50,21 +50,21 @@ static const IdentInterfaceSymbol kCaptureWhatStrings[ ScreenshotCommand::nCaptureWhats ] = { { XO("Window") }, - { XO("Full_Window") }, - { XO("Window_Plus") }, + { wxT("FullWindow"), XO("Full Window") }, + { wxT("WindowPlus"), XO("Window Plus") }, { XO("Fullscreen") }, { XO("Toolbars") }, { XO("Effects") }, { XO("Scriptables") }, { XO("Preferences") }, { XO("Selectionbar") }, - { XO("Spectral_Selection") }, + { wxT("SpectralSelection"), XO("Spectral Selection") }, { XO("Tools") }, { XO("Transport") }, { XO("Mixer") }, { XO("Meter") }, - { XO("Play_Meter") }, - { XO("Record_Meter") }, + { wxT("PlayMeter"), XO("Play Meter") }, + { wxT("RecordMeter"), XO("Record Meter") }, { XO("Edit") }, { XO("Device") }, { XO("Scrub") }, @@ -72,21 +72,22 @@ kCaptureWhatStrings[ ScreenshotCommand::nCaptureWhats ] = { XO("Trackpanel") }, { XO("Ruler") }, { XO("Tracks") }, - { XO("First_Track") }, - { XO("First_Two_Tracks") }, - { XO("First_Three_Tracks") }, - { XO("First_Four_Tracks") }, - { XO("Second_Track") }, - { XO("Tracks_Plus") }, - { XO("First_Track_Plus") }, - { XO("All_Tracks") }, - { XO("All_Tracks_Plus") }, + { wxT("FirstTrack"), XO("First Track") }, + { wxT("FirstTwoTracks"), XO("First Two Tracks") }, + { wxT("FirstThreeTracks"), XO("First Three Tracks") }, + { wxT("FirstFourTracks"), XO("First Four Tracks") }, + { wxT("SecondTrack"), XO("Second Track") }, + { wxT("TracksPlus"), XO("Tracks Plus") }, + { wxT("FirstTrackPlus"), XO("First Track Plus") }, + { wxT("AllTracks"), XO("All Tracks") }, + { wxT("AllTracksPlus"), XO("All Tracks Plus") }, }; static const IdentInterfaceSymbol kBackgroundStrings[ ScreenshotCommand::nBackgrounds ] = { + // These are acceptable dual purpose internal/visible names { XO("Blue") }, { XO("White") }, { XO("None") }, diff --git a/src/commands/SelectCommand.cpp b/src/commands/SelectCommand.cpp index 414f5c59a..c44a49c20 100644 --- a/src/commands/SelectCommand.cpp +++ b/src/commands/SelectCommand.cpp @@ -46,12 +46,12 @@ explicitly code all three. const int nRelativeTos =6; static const IdentInterfaceSymbol kRelativeTo[nRelativeTos] = { - { XO("Project Start") }, + { wxT("ProjectStart"), XO("Project Start") }, { XO("Project") }, - { XO("Project End") }, - { XO("Selection Start") }, + { wxT("ProjectEnd"), XO("Project End") }, + { wxT("SelectionStart"), XO("Selection Start") }, { XO("Selection") }, - { XO("Selection End") } + { wxT("SelectionEnd"), XO("Selection End") } }; bool SelectTimeCommand::DefineParams( ShuttleParams & S ){ @@ -169,6 +169,8 @@ bool SelectFrequenciesCommand::Apply(const CommandContext & context){ const int nModes =3; static const IdentInterfaceSymbol kModes[nModes] = { + // These are acceptable dual purpose internal/visible names + /* i18n-hint verb, imperative */ { XO("Set") }, { XO("Add") }, diff --git a/src/commands/SetClipCommand.cpp b/src/commands/SetClipCommand.cpp index be6c3caba..c73fb9eea 100644 --- a/src/commands/SetClipCommand.cpp +++ b/src/commands/SetClipCommand.cpp @@ -40,10 +40,10 @@ enum kColours static const IdentInterfaceSymbol kColourStrings[nColours] = { - { XO("Color0") }, - { XO("Color1") }, - { XO("Color2") }, - { XO("Color3") }, + { wxT("Color0"), XO("Color 0") }, + { wxT("Color1"), XO("Color 1") }, + { wxT("Color2"), XO("Color 2") }, + { wxT("Color3"), XO("Color 3") }, }; diff --git a/src/commands/SetTrackInfoCommand.cpp b/src/commands/SetTrackInfoCommand.cpp index f2c4df7d4..b1974b46b 100644 --- a/src/commands/SetTrackInfoCommand.cpp +++ b/src/commands/SetTrackInfoCommand.cpp @@ -238,10 +238,10 @@ enum kColours static const IdentInterfaceSymbol kColourStrings[nColours] = { - { XO("Color0") }, - { XO("Color1") }, - { XO("Color2") }, - { XO("Color3") }, + { wxT("Color0"), XO("Color 0") }, + { wxT("Color1"), XO("Color 1") }, + { wxT("Color2"), XO("Color 2") }, + { wxT("Color3"), XO("Color 3") }, }; @@ -254,6 +254,7 @@ enum kDisplayTypes static const IdentInterfaceSymbol kDisplayTypeStrings[nDisplayTypes] = { + // These are acceptable dual purpose internal/visible names { XO("Waveform") }, { XO("Spectrogram") }, }; @@ -267,7 +268,9 @@ enum kScaleTypes static const IdentInterfaceSymbol kScaleTypeStrings[nScaleTypes] = { + // These are acceptable dual purpose internal/visible names { XO("Linear") }, + /* i18n-hint: abbreviates decibels */ { XO("dB") }, }; @@ -282,7 +285,7 @@ enum kZoomTypes static const IdentInterfaceSymbol kZoomTypeStrings[nZoomTypes] = { { XO("Reset") }, - { XO("Times2") }, + { wxT("Times2"), XO("Times 2") }, { XO("HalfWave") }, }; diff --git a/src/effects/Distortion.cpp b/src/effects/Distortion.cpp index 4e56be899..5e1a047ab 100644 --- a/src/effects/Distortion.cpp +++ b/src/effects/Distortion.cpp @@ -59,17 +59,17 @@ enum kTableType static const IdentInterfaceSymbol kTableTypeStrings[nTableTypes] = { - { XO("Hard Clipping") }, - { XO("Soft Clipping") }, - { XO("Soft Overdrive") }, - { XO("Medium Overdrive") }, - { XO("Hard Overdrive") }, - { XO("Cubic Curve (odd harmonics)") }, - { XO("Even Harmonics") }, - { XO("Expand and Compress") }, + { wxT("HardClipping"), XO("Hard Clipping") }, + { wxT("SoftClipping"), XO("Soft Clipping") }, + { wxT("SoftOverdrive"), XO("Soft Overdrive") }, + { wxT("MediumOverdrive"), XO("Medium Overdrive") }, + { wxT("HardOverdrive"), XO("Hard Overdrive") }, + { wxT("CubicCurveOddHarmonics"), XO("Cubic Curve (odd harmonics)") }, + { wxT("EvenHarmonics"), XO("Even Harmonics") }, + { wxT("ExpandCompress"), XO("Expand and Compress") }, { XO("Leveller") }, - { XO("Rectifier Distortion") }, - { XO("Hard Limiter 1413") } + { wxT("RectifierDistortion"), XO("Rectifier Distortion") }, + { wxT("HardLimiter1413"), XO("Hard Limiter 1413") } }; // Define keys, defaults, minimums, and maximums for the effect parameters diff --git a/src/effects/Equalization.cpp b/src/effects/Equalization.cpp index 1f190359b..55f6a5d54 100644 --- a/src/effects/Equalization.cpp +++ b/src/effects/Equalization.cpp @@ -146,6 +146,8 @@ enum kInterpolations static const IdentInterfaceSymbol kInterpStrings[nInterpolations] = { + // These are acceptable dual purpose internal/visible names + /* i18n-hint: Technical term for a kind of curve.*/ { XO("B-spline") }, { XO("Cosine") }, diff --git a/src/effects/Noise.cpp b/src/effects/Noise.cpp index 15752bba0..53978b043 100644 --- a/src/effects/Noise.cpp +++ b/src/effects/Noise.cpp @@ -37,6 +37,7 @@ enum kTypes static const IdentInterfaceSymbol kTypeStrings[nTypes] = { + // These are acceptable dual purpose internal/visible names { XO("White") }, { XO("Pink") }, { XO("Brownian") } diff --git a/src/effects/ScienFilter.cpp b/src/effects/ScienFilter.cpp index 276dbbeb0..78ee013d0 100644 --- a/src/effects/ScienFilter.cpp +++ b/src/effects/ScienFilter.cpp @@ -91,9 +91,9 @@ static const IdentInterfaceSymbol kTypeStrings[nTypes] = /*i18n-hint: Butterworth is the name of the person after whom the filter type is named.*/ { XO("Butterworth") }, /*i18n-hint: Chebyshev is the name of the person after whom the filter type is named.*/ - { XO("Chebyshev Type I") }, + { wxT("ChebyshevTypeI"), XO("Chebyshev Type I") }, /*i18n-hint: Chebyshev is the name of the person after whom the filter type is named.*/ - { XO("Chebyshev Type II") } + { wxT("ChebyshevTypeII"), XO("Chebyshev Type II") } }; enum kSubTypes @@ -105,6 +105,7 @@ enum kSubTypes static const IdentInterfaceSymbol kSubTypeStrings[nSubTypes] = { + // These are acceptable dual purpose internal/visible names { XO("Lowpass") }, { XO("Highpass") } }; diff --git a/src/effects/ToneGen.cpp b/src/effects/ToneGen.cpp index 8dc8fd63b..a78363b09 100644 --- a/src/effects/ToneGen.cpp +++ b/src/effects/ToneGen.cpp @@ -41,6 +41,7 @@ enum kInterpolations static const IdentInterfaceSymbol kInterStrings[nInterpolations] = { + // These are acceptable dual purpose internal/visible names { XO("Linear") }, { XO("Logarithmic") } }; @@ -59,7 +60,7 @@ static const IdentInterfaceSymbol kWaveStrings[nWaveforms] = { XO("Sine") }, { XO("Square") }, { XO("Sawtooth") }, - { XO("Square, no alias") } + { wxT("SquareNoAlias"), XO("Square, no alias") } }; // Define keys, defaults, minimums, and maximums for the effect parameters diff --git a/src/effects/TruncSilence.cpp b/src/effects/TruncSilence.cpp index c7e67332a..aa824bc73 100644 --- a/src/effects/TruncSilence.cpp +++ b/src/effects/TruncSilence.cpp @@ -42,6 +42,8 @@ public: }; const IdentInterfaceSymbol Enums::DbChoices[] = { + // Yuck, why is this a choice control and not a slider? I'm leaving this + // table of names alone for now -- PRL { wxT("-20 dB") }, { wxT("-25 dB") }, { wxT("-30 dB") }, @@ -79,8 +81,8 @@ enum kActions static const IdentInterfaceSymbol kActionStrings[nActions] = { - { XO("Truncate Detected Silence") }, - { XO("Compress Excess Silence") } + { wxT("Truncate"), XO("Truncate Detected Silence") }, + { wxT("Compress"), XO("Compress Excess Silence") } }; static CommandParameters::ObsoleteMap kObsoleteActions[] = {