Namespace the env_vars.h functions

common/dialogs/dialog_configure_paths.cpp

@@ -185,7 +185,7 @@ void DIALOG_CONFIGURE_PATHS::AppendEnvVar( const wxString& aName, const wxString
     wxGridCellTextEditor* nameTextEditor = new GRID_CELL_TEXT_EDITOR();
     nameTextEditor->SetValidator( ENV_VAR_NAME_VALIDATOR() );
     nameCellAttr->SetEditor( nameTextEditor );
-    nameCellAttr->SetReadOnly( IsEnvVarImmutable( aName ) );
+    nameCellAttr->SetReadOnly( ENV_VAR::IsEnvVarImmutable( aName ) );
     nameCellAttr->DecRef();
 
     m_EnvVars->SetCellValue( i, TV_VALUE_COL, aPath );
@@ -405,7 +405,7 @@ void DIALOG_CONFIGURE_PATHS::OnRemoveEnvVar( wxCommandEvent& event )
 
     if( curRow < 0 || m_EnvVars->GetNumberRows() <= curRow )
         return;
-    else if( IsEnvVarImmutable( m_EnvVars->GetCellValue( curRow, TV_NAME_COL ) ) )
+    else if( ENV_VAR::IsEnvVarImmutable( m_EnvVars->GetCellValue( curRow, TV_NAME_COL ) ) )
     {
         wxBell();
         return;
@@ -586,11 +586,11 @@ void DIALOG_CONFIGURE_PATHS::OnHelp( wxCommandEvent& event )
               "will only accept upper case letters, digits, and the underscore characters." );
     msg << "</b>";
 
-    for( const auto& var: GetPredefinedEnvVars() )
+    for( const auto& var : ENV_VAR::GetPredefinedEnvVars() )
     {
         msg << "<br><br><b>" << var << "</b>";
 
-        const auto desc = LookUpEnvVarHelp( var );
+        const auto desc = ENV_VAR::LookUpEnvVarHelp( var );
 
         if( desc.size() > 0 )
             msg << ": " << desc;

common/env_vars.cpp

@@ -33,7 +33,7 @@ using STRING_MAP = std::map<wxString, wxString>;
  * extract them from elsewhere in the program
  * (where they are originally defined)
  */
-static const ENV_VAR_LIST predefined_env_vars = {
+static const ENV_VAR::ENV_VAR_LIST predefinedEnvVars = {
     "KIPRJMOD",
     "KICAD6_SYMBOL_DIR",
     "KICAD6_3DMODEL_DIR",
@@ -44,9 +44,9 @@ static const ENV_VAR_LIST predefined_env_vars = {
 };
 
 
-bool IsEnvVarImmutable( const wxString& aEnvVar )
+bool ENV_VAR::IsEnvVarImmutable( const wxString& aEnvVar )
 {
-    for( const auto& s: predefined_env_vars )
+    for( const auto& s : predefinedEnvVars )
     {
         if( s == aEnvVar )
             return true;
@@ -56,13 +56,13 @@ bool IsEnvVarImmutable( const wxString& aEnvVar )
 }
 
 
-const ENV_VAR_LIST& GetPredefinedEnvVars()
+const ENV_VAR::ENV_VAR_LIST& ENV_VAR::GetPredefinedEnvVars()
 {
-    return predefined_env_vars;
+    return predefinedEnvVars;
 }
 
 
-void initialiseEnvVarHelp( STRING_MAP& aMap )
+static void initialiseEnvVarHelp( STRING_MAP& aMap )
 {
     // Set up dynamically, as we want to be able to use _() translations,
     // which can't be done statically
@@ -101,21 +101,21 @@ void initialiseEnvVarHelp( STRING_MAP& aMap )
 }
 
 
-wxString LookUpEnvVarHelp( const wxString& aEnvVar )
+wxString ENV_VAR::LookUpEnvVarHelp( const wxString& aEnvVar )
 {
-    static STRING_MAP env_var_help_text;
+    static STRING_MAP envVarHelpText;
 
-    if( env_var_help_text.size() == 0 )
-        initialiseEnvVarHelp( env_var_help_text );
+    if( envVarHelpText.size() == 0 )
+        initialiseEnvVarHelp( envVarHelpText );
 
-    return env_var_help_text[aEnvVar];
+    return envVarHelpText[ aEnvVar ];
 }
 
 
 template<>
-OPT<double> GetEnvVar( const wxString& aEnvVarName )
+OPT<double> ENV_VAR::GetEnvVar( const wxString& aEnvVarName )
 {
-    OPT<double> opt_value;
+    OPT<double> optValue;
 
     wxString env;
     if( wxGetEnv( aEnvVarName, &env ) )
@@ -123,23 +123,23 @@ OPT<double> GetEnvVar( const wxString& aEnvVarName )
         double value;
         if( env.ToDouble( &value ) )
         {
-            opt_value = value;
+            optValue = value;
         }
     }
 
-    return opt_value;
+    return optValue;
 }
 
 template<>
-OPT<wxString> GetEnvVar( const wxString& aEnvVarName )
+OPT<wxString> ENV_VAR::GetEnvVar( const wxString& aEnvVarName )
 {
-    OPT<wxString> opt_value;
+    OPT<wxString> optValue;
 
     wxString env;
     if( wxGetEnv( aEnvVarName, &env ) )
     {
-        opt_value = env;
+        optValue = env;
     }
 
-    return opt_value;
+    return optValue;
 }

common/gal/dpi_scaling.cpp

@@ -80,7 +80,7 @@ static OPT<double> getEnvironmentScale()
     if( port_id == wxPORT_GTK )
     {
         // Under GTK, the user can use GDK_SCALE to force the scaling
-        scale = GetEnvVar<double>( "GDK_SCALE" );
+        scale = ENV_VAR::GetEnvVar<double>( "GDK_SCALE" );
     }
 
     if( scale )

include/env_paths.h

@@ -68,15 +68,4 @@ wxString NormalizePath( const wxFileName& aFilePath, const ENV_VAR_MAP* aEnvVars
 wxString ResolveFile( const wxString& aFileName, const ENV_VAR_MAP* aEnvVars,
                       const PROJECT* aProject );
 
-/**
- * Check if a given filename is within a given project directory (not whether it exists!)
- *
- * @param aFileName is the absolute path to check
- * @param aProject is the project to test against
- * @param aSubPath will be filled with the relative path to the file inside the project (if any)
- * @return true if aFileName's path is inside aProject's path
- */
-bool PathIsInsideProject( const wxString& aFileName, const PROJECT* aProject,
-                          wxFileName* aSubPath = nullptr );
-
 #endif /* ENV_PATHS_H */

include/env_vars.h

@@ -26,11 +26,11 @@
 #define ENV_VARS_H
 
 #include <wx/string.h>
-
 #include <vector>
-
 #include <core/optional.h>
 
+namespace ENV_VAR
+{
     using ENV_VAR_LIST = std::vector<wxString>;
 
     /**
@@ -86,6 +86,6 @@ OPT<wxString> GetEnvVar( const wxString& aEnvVarName );
      */
     template <>
     OPT<double> GetEnvVar( const wxString& aEnvVarName );
-
+};
 
 #endif /* ENV_VARS_H */