DevWiki/calculator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add error handling to graph and equations (#827)

Browse Source 
* add error handling

* Handle regraphing on certain errors

* Fix high contrast

* Hide KGF button in error state
This commit is contained in:
Pepe Rivera
2019-12-03 14:41:39 -08:00
committed by Eric Wong
parent 3ca4f4ffa7
commit 89c3fc3e4d
14 changed files with 397 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/GraphControl/Control/Equation.cpp
View File

@@ -26,7 +26,13 @@ namespace GraphControl
DependencyProperty ^ Equation::s_isLineEnabledProperty;
static constexpr auto s_propertyName_IsLineEnabled = L"IsLineEnabled";
DependencyProperty ^ Equation::s_xInterceptProperty;
DependencyProperty ^ Equation::s_hasGraphErrorProperty;
static constexpr auto s_propertyName_HasGraphError = L"HasGraphError";
DependencyProperty ^ Equation::s_isValidatedProperty;
static constexpr auto s_propertyName_IsValidated = L"IsValidated";
DependencyProperty ^ Equation::s_xInterceptProperty;
static constexpr auto s_propertyName_XIntercept = L"XIntercept";
DependencyProperty ^ Equation::s_yInterceptProperty;
@@ -79,6 +85,8 @@ namespace GraphControl
String ^ Expression = StringReference(s_propertyName_Expression);
String ^ LineColor = StringReference(s_propertyName_LineColor);
String ^ IsLineEnabled = StringReference(s_propertyName_IsLineEnabled);
String ^ HasGraphError = StringReference(s_propertyName_HasGraphError);
String ^ IsValidated = StringReference(s_propertyName_IsValidated);
String ^ XIntercept = StringReference(s_propertyName_XIntercept);
String ^ YIntercept = StringReference(s_propertyName_YIntercept);
String ^ Parity = StringReference(s_propertyName_Parity);
@@ -129,6 +137,24 @@ namespace GraphControl
ref new PropertyMetadata(nullptr, ref new PropertyChangedCallback(&Equation::OnCustomDependencyPropertyChanged)));
}
if (!s_hasGraphErrorProperty)
{
s_hasGraphErrorProperty = DependencyProperty::Register(
EquationProperties::HasGraphError,
bool ::typeid,
Equation::typeid,
ref new PropertyMetadata(false, ref new PropertyChangedCallback(&Equation::OnCustomDependencyPropertyChanged)));
}
if (!s_isValidatedProperty)
{
s_isValidatedProperty = DependencyProperty::Register(
EquationProperties::IsValidated,
bool ::typeid,
Equation::typeid,
ref new PropertyMetadata(false, ref new PropertyChangedCallback(&Equation::OnCustomDependencyPropertyChanged)));
}
if (!s_xInterceptProperty)
{
s_xInterceptProperty = DependencyProperty::Register(
@@ -354,6 +380,14 @@ namespace GraphControl
{
propertyName = EquationProperties::AnalysisError;
}
else if (args->Property == s_hasGraphErrorProperty)
{
propertyName = EquationProperties::HasGraphError;
}
else if (args->Property == s_isValidatedProperty)
{
propertyName = EquationProperties::IsValidated;
}
eq->PropertyChanged(eq, propertyName);
}
@@ -398,4 +432,9 @@ namespace GraphControl
{
return L""s;
}
bool Equation::IsGraphableEquation()
{
return !Expression->IsEmpty() && IsLineEnabled && !HasGraphError;
}
}

73
src/GraphControl/Control/Equation.h
View File

@@ -91,6 +91,44 @@ namespace GraphControl
#pragma endregion
#pragma region bool HasGraphError DependencyProperty
static property Windows::UI::Xaml::DependencyProperty ^ HasGraphErrorProperty { Windows::UI::Xaml::DependencyProperty ^ get() { return s_hasGraphErrorProperty; } }
property bool HasGraphError
{
bool get()
{
return static_cast<bool>(GetValue(s_hasGraphErrorProperty));
}
internal:
void set(bool value)
{
SetValue(s_hasGraphErrorProperty, value);
}
}
#pragma endregion
#pragma region bool IsValidated DependencyProperty
static property Windows::UI::Xaml::DependencyProperty ^ IsValidatedProperty { Windows::UI::Xaml::DependencyProperty ^ get() { return s_isValidatedProperty; } }
property bool IsValidated
{
bool get()
{
return static_cast<bool>(GetValue(s_isValidatedProperty));
}
internal:
void set(bool value)
{
SetValue(s_isValidatedProperty, value);
}
}
#pragma endregion
#pragma region Key Graph Features
@@ -108,7 +146,7 @@ namespace GraphControl
{
return static_cast<Platform::String^>(GetValue(s_xInterceptProperty));
}
void set(Platform::String^ value)
internal: void set(Platform::String^ value)
{
SetValue(s_xInterceptProperty, value);
}
@@ -129,7 +167,7 @@ namespace GraphControl
{
return static_cast<Platform::String^>(GetValue(s_yInterceptProperty));
}
void set(Platform::String^ value)
internal: void set(Platform::String^ value)
{
SetValue(s_yInterceptProperty, value);
}
@@ -150,7 +188,7 @@ namespace GraphControl
{
return static_cast<int>(GetValue(s_parityProperty));
}
void set(int value)
internal: void set(int value)
{
SetValue(s_parityProperty, value);
}
@@ -171,7 +209,7 @@ namespace GraphControl
{
return static_cast<int>(GetValue(s_periodicityDirectionProperty));
}
void set(int value)
internal: void set(int value)
{
SetValue(s_periodicityDirectionProperty, value);
}
@@ -192,7 +230,7 @@ namespace GraphControl
{
return static_cast<Platform::String ^>(GetValue(s_periodicityExpressionProperty));
}
void set(Platform::String ^ value)
internal: void set(Platform::String ^ value)
{
SetValue(s_periodicityExpressionProperty, value);
}
@@ -213,7 +251,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_minimaProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_minimaProperty, value);
}
@@ -234,7 +272,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_maximaProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_maximaProperty, value);
}
@@ -255,7 +293,7 @@ namespace GraphControl
{
return static_cast<Platform::String^>(GetValue(s_domainProperty));
}
void set(Platform::String^ value)
internal: void set(Platform::String^ value)
{
SetValue(s_domainProperty, value);
}
@@ -276,7 +314,7 @@ namespace GraphControl
{
return static_cast<Platform::String^>(GetValue(s_rangeProperty));
}
void set(Platform::String^ value)
internal: void set(Platform::String^ value)
{
SetValue(s_rangeProperty, value);
}
@@ -297,7 +335,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_inflectionPointsProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_inflectionPointsProperty, value);
}
@@ -318,7 +356,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IObservableMap<Platform::String^, Platform::String ^> ^>(GetValue(s_monotonicityProperty));
}
void set(Windows::Foundation::Collections::IObservableMap<Platform::String^, Platform::String ^> ^ value)
internal: void set(Windows::Foundation::Collections::IObservableMap<Platform::String^, Platform::String ^> ^ value)
{
SetValue(s_monotonicityProperty, value);
}
@@ -339,7 +377,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_verticalAsymptotesProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_verticalAsymptotesProperty, value);
}
@@ -360,7 +398,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_horizontalAsymptotesProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_horizontalAsymptotesProperty, value);
}
@@ -381,7 +419,7 @@ namespace GraphControl
{
return static_cast<Windows::Foundation::Collections::IVector<Platform::String^> ^>(GetValue(s_obliqueAsymptotesProperty));
}
void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
internal: void set(Windows::Foundation::Collections::IVector<Platform::String^> ^ value)
{
SetValue(s_obliqueAsymptotesProperty, value);
}
@@ -402,7 +440,7 @@ namespace GraphControl
{
return static_cast<int>(GetValue(s_tooComplexFeaturesProperty));
}
void set(int value)
internal: void set(int value)
{
SetValue(s_tooComplexFeaturesProperty, value);
}
@@ -423,7 +461,7 @@ namespace GraphControl
{
return static_cast<int>(GetValue(s_analysisErrorProperty));
}
void set(int value)
internal: void set(int value)
{
SetValue(s_analysisErrorProperty, value);
}
@@ -434,6 +472,7 @@ namespace GraphControl
internal : event PropertyChangedEventHandler ^ PropertyChanged;
std::wstring GetRequest();
bool IsGraphableEquation();
private:
static void OnCustomDependencyPropertyChanged(Windows::UI::Xaml::DependencyObject ^ obj, Windows::UI::Xaml::DependencyPropertyChangedEventArgs ^ args);
@@ -446,6 +485,8 @@ namespace GraphControl
static Windows::UI::Xaml::DependencyProperty ^ s_expressionProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_lineColorProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_isLineEnabledProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_hasGraphErrorProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_isValidatedProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_xInterceptProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_yInterceptProperty;
static Windows::UI::Xaml::DependencyProperty ^ s_parityProperty;

10
src/GraphControl/Control/EquationCollection.h
View File

@@ -7,7 +7,7 @@
namespace GraphControl
{
delegate void EquationChangedEventHandler();
delegate void EquationChangedEventHandler(Equation ^ sender);
delegate void VisibilityChangedEventHandler(Equation ^ sender);
public
@@ -151,19 +151,19 @@ public
event EquationChangedEventHandler ^ EquationLineEnabledChanged;
private:
void OnEquationPropertyChanged(GraphControl::Equation ^, Platform::String ^ propertyName)
void OnEquationPropertyChanged(GraphControl::Equation ^ sender, Platform::String ^ propertyName)
{
if (propertyName == EquationProperties::LineColor)
{
EquationStyleChanged();
EquationStyleChanged(sender);
}
else if (propertyName == EquationProperties::Expression)
{
EquationChanged();
EquationChanged(sender);
}
else if (propertyName == EquationProperties::IsLineEnabled)
{
EquationLineEnabledChanged();
EquationLineEnabledChanged(sender);
}
}

154
src/GraphControl/Control/Grapher.cpp
View File

@@ -62,7 +62,7 @@ namespace GraphControl
, m_Moving{ false }
{
m_solver->ParsingOptions().SetFormatType(s_defaultFormatType);
m_solver->FormatOptions().SetFormatType(FormatType::MathML);
m_solver->FormatOptions().SetFormatType(s_defaultFormatType);
m_solver->FormatOptions().SetMathMLPrefix(wstring(L"mml"));
DefaultStyleKey = StringReference(s_defaultStyleKey);
@@ -144,7 +144,7 @@ namespace GraphControl
m_renderMain = ref new RenderMain(swapChainPanel);
}
UpdateGraph();
TryUpdateGraph();
}
void Grapher::RegisterDependencyProperties()
@@ -229,19 +229,26 @@ namespace GraphControl
ref new EquationChangedEventHandler(this, &Grapher::OnEquationLineEnabledChanged);
}
UpdateGraph();
PlotGraph();
}
void Grapher::OnEquationChanged()
void Grapher::OnEquationChanged(Equation ^ equation)
{
UpdateGraph();
// If the equation was previously valid, we should try to graph again in the event of the failure
bool shouldRetry = equation->IsValidated;
// Reset these properties if the equation is requesting to be graphed again
equation->HasGraphError = false;
equation->IsValidated = false;
TryPlotGraph(shouldRetry);
}
void Grapher::OnEquationStyleChanged()
void Grapher::OnEquationStyleChanged(Equation ^)
{
if (m_graph)
{
UpdateGraphOptions(m_graph->GetOptions(), GetValidEquations());
UpdateGraphOptions(m_graph->GetOptions(), GetGraphableEquations());
}
if (m_renderMain)
@@ -250,14 +257,15 @@ namespace GraphControl
}
}
void Grapher::OnEquationLineEnabledChanged()
void Grapher::OnEquationLineEnabledChanged(Equation ^ equation)
{
UpdateGraph();
}
// If the equation is in an error state or is empty, it should not be graphed anyway.
if (equation->HasGraphError || equation->Expression->IsEmpty())
{
return;
}
void Grapher::PlotGraph()
{
UpdateGraph();
PlotGraph();
}
void Grapher::AnalyzeEquation(Equation ^ equation)
@@ -307,13 +315,43 @@ namespace GraphControl
equation->AnalysisError = CalculatorApp::AnalysisErrorType::AnalysisCouldNotBePerformed;
}
void Grapher::UpdateGraph()
void Grapher::PlotGraph()
{
TryPlotGraph(false);
}
void Grapher::TryPlotGraph(bool shouldRetry)
{
if (TryUpdateGraph())
{
SetEquationsAsValid();
}
else
{
SetEquationErrors();
// If we failed to plot the graph, try again after the bad equations are flagged.
if (shouldRetry)
{
TryUpdateGraph();
}
}
}
bool Grapher::TryUpdateGraph()
{
optional<vector<shared_ptr<IEquation>>> initResult = nullopt;
bool successful = false;
if (m_renderMain && m_graph != nullptr)
{
auto validEqs = GetValidEquations();
unique_ptr<IExpression> graphExpression;
wstring request;
auto validEqs = GetGraphableEquations();
// Will be set to true if the previous graph should be kept in the event of an error
bool shouldKeepPreviousGraph = false;
if (!validEqs.empty())
{
@@ -323,6 +361,11 @@ namespace GraphControl
int numValidEquations = 0;
for (Equation ^ eq : validEqs)
{
if (eq->IsValidated)
{
shouldKeepPreviousGraph = true;
}
if (numValidEquations++ > 0)
{
ss << L"<mo>,</mo>";
@@ -333,26 +376,78 @@ namespace GraphControl
ss << s_getGraphClosingTags;
wstring request = ss.str();
unique_ptr<IExpression> graphExpression;
if (graphExpression = m_solver->ParseInput(request))
request = ss.str();
}
if (graphExpression = m_solver->ParseInput(request))
{
initResult = m_graph->TryInitialize(graphExpression.get());
if (initResult != nullopt)
{
initResult = m_graph->TryInitialize(graphExpression.get());
UpdateGraphOptions(m_graph->GetOptions(), validEqs);
SetGraphArgs();
m_renderMain->Graph = m_graph;
// It is possible that the render fails, in that case fall through to explicit empty initialization
if (m_renderMain->RunRenderPass())
{
UpdateVariables();
successful = true;
}
else
{
// If we failed to render then we have already lost the previous graph
shouldKeepPreviousGraph = false;
initResult = nullopt;
}
}
}
if (initResult == nullopt)
{
initResult = m_graph->TryInitialize();
// Do not re-initialize the graph to empty if there are still valid equations graphed
if (!shouldKeepPreviousGraph)
{
initResult = m_graph->TryInitialize();
if (initResult != nullopt)
{
UpdateGraphOptions(m_graph->GetOptions(), validEqs);
SetGraphArgs();
m_renderMain->Graph = m_graph;
m_renderMain->RunRenderPass();
UpdateVariables();
// Initializing an empty graph is only a success if there were no equations to graph.
successful = (validEqs.size() == 0);
}
}
}
}
if (initResult != nullopt)
// Return true if we were able to graph and render all graphable equations
return successful;
}
void Grapher::SetEquationsAsValid()
{
for (Equation ^ eq : GetGraphableEquations())
{
eq->IsValidated = true;
}
}
void Grapher::SetEquationErrors()
{
for (Equation ^ eq : GetGraphableEquations())
{
if (!eq->IsValidated)
{
UpdateGraphOptions(m_graph->GetOptions(), validEqs);
SetGraphArgs();
UpdateVariables();
m_renderMain->Graph = m_graph;
eq->HasGraphError = true;
}
}
}
@@ -417,6 +512,7 @@ namespace GraphControl
void Grapher::UpdateVariables()
{
auto updatedVariables = ref new Map<String ^, double>();
if (m_graph)
{
auto graphVariables = m_graph->GetVariables();
@@ -484,13 +580,13 @@ namespace GraphControl
}
}
vector<Equation ^> Grapher::GetValidEquations()
vector<Equation ^> Grapher::GetGraphableEquations()
{
vector<Equation ^> validEqs;
for (Equation ^ eq : Equations)
{
if (!eq->Expression->IsEmpty() && eq->IsLineEnabled)
if (eq->IsGraphableEquation())
{
validEqs.push_back(eq);
}
@@ -501,7 +597,7 @@ namespace GraphControl
void Grapher::OnForceProportionalAxesChanged(DependencyPropertyChangedEventArgs ^ args)
{
UpdateGraph();
TryUpdateGraph();
}
void Grapher::OnBackgroundColorChanged(const Windows::UI::Color& color)

14
src/GraphControl/Control/Grapher.h
View File

@@ -171,12 +171,13 @@ public
void OnDependencyPropertyChanged(Windows::UI::Xaml::DependencyObject ^ obj, Windows::UI::Xaml::DependencyProperty ^ p);
void OnEquationsChanged(Windows::UI::Xaml::DependencyPropertyChangedEventArgs ^ args);
void OnEquationChanged();
void OnEquationStyleChanged();
void OnEquationLineEnabledChanged();
void UpdateGraph();
void OnEquationChanged(GraphControl::Equation ^ equation);
void OnEquationStyleChanged(GraphControl::Equation ^ equation);
void OnEquationLineEnabledChanged(GraphControl::Equation ^ equation);
bool TryUpdateGraph();
void TryPlotGraph(bool shouldRetry);
void UpdateGraphOptions(Graphing::IGraphingOptions& options, const std::vector<Equation ^>& validEqs);
std::vector<Equation ^> GetValidEquations();
std::vector<Equation ^> GetGraphableEquations();
void SetGraphArgs();
std::shared_ptr<Graphing::IGraph> GetGraph(GraphControl::Equation ^ equation);
void UpdateVariables();
@@ -194,6 +195,9 @@ public
void HandleTracingMovementTick(Object ^ sender, Object ^ e);
void HandleKey(bool keyDown, Windows::System::VirtualKey key);
void SetEquationsAsValid();
void SetEquationErrors();
Windows::Foundation::Collections::IObservableVector<Platform::String ^> ^ ConvertWStringVector(std::vector<std::wstring> inVector);
Windows::Foundation::Collections::IObservableMap<Platform::String ^, Platform::String ^> ^ ConvertWStringIntMap(std::map<std::wstring, int> inMap);

10
src/GraphControl/DirectX/RenderMain.cpp
View File

@@ -68,8 +68,6 @@ namespace GraphControl::DX
renderer->SetGraphSize(static_cast<unsigned int>(m_swapChainPanel->ActualWidth), static_cast<unsigned int>(m_swapChainPanel->ActualHeight));
}
}
RunRenderPass();
}
void RenderMain::BackgroundColor::set(Windows::UI::Color backgroundColor)
@@ -125,12 +123,16 @@ namespace GraphControl::DX
RunRenderPass();
}
void RenderMain::RunRenderPass()
bool RenderMain::RunRenderPass()
{
if (Render())
bool succesful = Render();
if (succesful)
{
m_deviceResources.Present();
}
return succesful;
}
// Renders the current frame according to the current application state.

2
src/GraphControl/DirectX/RenderMain.h
View File

@@ -46,7 +46,7 @@ namespace GraphControl::DX
void CreateWindowSizeDependentResources();
void RunRenderPass();
bool RunRenderPass();
// Indicates if we are in active tracing mode (the tracing box is being used and controlled through keyboard input)
property bool ActiveTracing