Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Redesign Exception classes w/ boost::exception #219

Closed
rakhimov opened this issue Aug 23, 2017 · 0 comments
Closed

Redesign Exception classes w/ boost::exception #219

rakhimov opened this issue Aug 23, 2017 · 0 comments
Labels
quality
Milestone
v0.16.0

Comments

@rakhimov
Copy link
Owner

rakhimov commented Aug 23, 2017 •
edited
Loading

The current scram exception classes
are string-ly context & error carriers,
which are noexcept-incorrect, localization unfriendly, and inflexible.
For example, dealing with libxml2 errors in this manner is a nightmare.

Boost exception library provides a solid framework
to properly design exception classes.

  • No error message construction at throw site
  • Provide more context data
  • Build the context data incrementally
  • Generic
  • Error message construction only at report site (front-ends)
  • Coherent and consistent design

The new design should help with proper libxml2 error extraction (#218)
and translation & localization of error messages (#216).
@rakhimov rakhimov added this to the v0.16.0 milestone Aug 23, 2017
@rakhimov rakhimov mentioned this issue Aug 23, 2017
Closed
4 tasks
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Derive Error from boost::exception
53ae0cc 
This uses virtual inheritance to derive from std::exception as well.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Add error::what tag to store identifier strings
0443c69 
This should replace the dynamic messages generated at throw site.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Add SCRAM_THROW macro as BOOST_THROW_EXCEPTION
f7570cd 
This is a helper macro to add more information
about the exception source.
Unlike BOOST_THROW_EXCEPTION,
SCRAM_THROW assumes that the exceptions derive from boost::exception.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Refactor dynamic exception type detection in main
4331d25 
Instead of using macro to stringify the exception types,
use boost::core::demangled_name to get the exception type name.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Refactor XML input errors w/ boost::errinfo data
57258ec 
File and line numbers can be attached as tagged data.
This removes the need for constructing message strings at throw site.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Remove unused ValueError
791fa51 
Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Use specific SettingsError instead of InvalidArg
a5af9c0 
For the analysis settings,
it is more specific to use custom exception class.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Move MEF specific Error classes to mef namespace
d35b831 
This is needed to further refine the data passed to exceptions.
The MEF specific validation errors should be used
instead of generic InvalidArgument error class.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Rename mef::ValidationError -> mef::ValidityError
85a0410 
This is in parallel to XML ValidityError.
Validation is a process,
so ValidationError would be confusing the process
with the actual model invariants (i.e., validity).

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Refactor InvalidArgument to mef::DomainError
882c413 
The MEF facilities deal with validating the model input and values.
InvalidArgument is too general.
The values are checked with validity tests,
and upon error, ValidityError is issued.

The DomainError helps validating Expression intervals.
This also removes the slicing code
converting InvalidArgument to ValidityError.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Remove InvalidArgument exception class
7e3288d 
This exception is too broad and has been misused.
Instead, use the new MEF validity exceptions.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Use IllegalOperation for **UNSAFE** DLL loads only
55296e9 
IllegalOperations are expected violations by users.
Other functionalities are LogicErrors.
Only CCF group code is needed to be switched to LogicError.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Validate BasicEvents & CCF groups one-by-one
74ad519 
Instead of showing all the invalid events and CCF groups,
a single invalid entity is shown as soon as it is detected.
This is in the same spirit as the other validation steps.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Separate Dynamic Library errors from IOError
637a931 
This is helpful to indicate the DL problems explicitly.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Refactor IOError with boost exception tags
1a54a23 
File name, open mode, and error code
can be transferred with existing boost exception tags.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Use mef::errinfo_container for MEF errors
c898890 
MEF containers can act as namespaces
to clarify the error location.
This is currently used for event trees.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Print LogicError in LOG(ERROR)
43862a7 
This is a more explicit way
to indicate unexpected internal logic errors.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Remove Error::kPrefix_ static string
7e8938b 
The SCRAM specific identifier is redundant.
Boost exception reporting dynamically prints the exception type.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Remove error::what tag
c711dda 
This tag has been a redundant way to specify the exception message.
The removal simplifies the Error class.
error.cc has become empty and unnecessary as well after this change.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Add xml::ValidityError and error tags
b11db50 
This XML error class differentiates errors from mef::ValidityError.
The tags identify XML element and attribute names.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Remove Error::msg() functions
442b788 
This removes the anti-pattern of string-ly carrying the context.
The context needs to be built with boost exception tags instead.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Use SCRAM_THROW instead of 'throw' statement
86632fa 
The macro adds function, source line and file information
to the diagnostic information.
This is similar to BOOST_THROW_EXCEPTION,
but it only works with SCRAM exceptions.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Catch main() exceptions in Debug mode as well
7f1755c 
The reason for catching only on Release mode
was the loss of exception type information.
Now with Boost exception and RTTI,
this information can be retrieved without loss,
so the Debug mode does not need to crash.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Add LIBXML_TEST_VERSION in main()
c4be83f 
This checks the ABI version for libxml2.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
Refactor XML Error handling w/ xml::Error classes
9e5950d 
The libxml2 library errors are converted into
boost::exception based errors
that carry the context in boost exception tags.
Parsing, validation, RNG, XInclude code reworked
to properly carry information from libxml2 xmlGetLastError.

However, libxml2 still prints its own error messages in stderr.
This needs to be configured separately for higher message verbosity.

Issue #219
rakhimov added a commit that referenced this issue Oct 15, 2017
@rakhimov
GUI: Use boost diagnostic_info for internal errors
03006cb 
These errors are not meant to be translated.
The maximum verbosity is desired for debugging purposes.

Issue #219
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
quality
Projects
None yet
Milestone
v0.16.0
Development

No branches or pull requests
1 participant
@rakhimov