Loading...
Searching...
No Matches
juce_ApplicationProperties.cpp
/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2022 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 7 End-User License
Agreement and JUCE Privacy Policy.
End User License Agreement: www.juce.com/juce-7-licence
Privacy Policy: www.juce.com/juce-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
ApplicationProperties::~ApplicationProperties()
{
closeFiles();
}
//==============================================================================
void ApplicationProperties::setStorageParameters (const PropertiesFile::Options& newOptions)
{
options = newOptions;
}
//==============================================================================
void ApplicationProperties::openFiles()
{
// You need to call setStorageParameters() before trying to get hold of the properties!
jassert (options.applicationName.isNotEmpty());
if (options.applicationName.isNotEmpty())
{
PropertiesFile::Options o (options);
if (userProps == nullptr)
{
o.commonToAllUsers = false;
userProps.reset (new PropertiesFile (o));
}
if (commonProps == nullptr)
{
o.commonToAllUsers = true;
commonProps.reset (new PropertiesFile (o));
}
userProps->setFallbackPropertySet (commonProps.get());
}
}
PropertiesFile* ApplicationProperties::getUserSettings()
{
if (userProps == nullptr)
openFiles();
return userProps.get();
}
PropertiesFile* ApplicationProperties::getCommonSettings (const bool returnUserPropsIfReadOnly)
{
if (commonProps == nullptr)
openFiles();
if (returnUserPropsIfReadOnly)
{
if (commonSettingsAreReadOnly == 0)
commonSettingsAreReadOnly = commonProps->save() ? -1 : 1;
if (commonSettingsAreReadOnly > 0)
return userProps.get();
}
return commonProps.get();
}
bool ApplicationProperties::saveIfNeeded()
{
return (userProps == nullptr || userProps->saveIfNeeded())
&& (commonProps == nullptr || commonProps->saveIfNeeded());
}
void ApplicationProperties::closeFiles()
{
userProps.reset();
commonProps.reset();
}
} // namespace juce
juce::ApplicationProperties::closeFiles
void closeFiles()
Definition juce_ApplicationProperties.cpp:97
juce::ApplicationProperties::getUserSettings
PropertiesFile * getUserSettings()
Definition juce_ApplicationProperties.cpp:66
juce::ApplicationProperties::getCommonSettings
PropertiesFile * getCommonSettings(bool returnUserPropsIfReadOnly)
Definition juce_ApplicationProperties.cpp:74
juce::ApplicationProperties::saveIfNeeded
bool saveIfNeeded()
Definition juce_ApplicationProperties.cpp:91
juce::ApplicationProperties::~ApplicationProperties
~ApplicationProperties()
Definition juce_ApplicationProperties.cpp:29
juce::ApplicationProperties::setStorageParameters
void setStorageParameters(const PropertiesFile::Options &options)
Definition juce_ApplicationProperties.cpp:35
juce::PropertiesFile
Definition juce_PropertiesFile.h:48
juce::String::isNotEmpty
bool isNotEmpty() const noexcept
Definition juce_String.h:316
juce::PropertiesFile::Options
Definition juce_PropertiesFile.h:61
juce::PropertiesFile::Options::applicationName
String applicationName
Definition juce_PropertiesFile.h:69