-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
344 implement user traits #345
Open
Matthew-Whitlock
wants to merge
2
commits into
develop
Choose a base branch
from
344-implement-user-traits
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
//@HEADER | ||
// ***************************************************************************** | ||
// | ||
// checkpoint_example_user_traits.cc | ||
// DARMA/magistrate => Serialization Library | ||
// | ||
// Copyright 2019 National Technology & Engineering Solutions of Sandia, LLC | ||
// (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. | ||
// Government retains certain rights in this software. | ||
// | ||
// Redistribution and use in source and binary forms, with or without | ||
// modification, are permitted provided that the following conditions are met: | ||
// | ||
// * Redistributions of source code must retain the above copyright notice, | ||
// this list of conditions and the following disclaimer. | ||
// | ||
// * Redistributions in binary form must reproduce the above copyright notice, | ||
// this list of conditions and the following disclaimer in the documentation | ||
// and/or other materials provided with the distribution. | ||
// | ||
// * Neither the name of the copyright holder nor the names of its | ||
// contributors may be used to endorse or promote products derived from this | ||
// software without specific prior written permission. | ||
// | ||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
// POSSIBILITY OF SUCH DAMAGE. | ||
// | ||
// Questions? Contact [email protected] | ||
// | ||
// ***************************************************************************** | ||
//@HEADER | ||
*/ | ||
#include "checkpoint/checkpoint.h" | ||
|
||
#include "checkpoint_example_user_traits.hpp" | ||
|
||
int main(int, char**){ | ||
using namespace test; | ||
TestObj obj; | ||
|
||
//Each invocation will be handled based on the traits attached | ||
auto s_info_a = checkpoint::serialize(obj); | ||
auto s_info_b = checkpoint::serialize<TestObj, checkpoint_trait>(obj); | ||
auto s_info_c = checkpoint::serialize<TestObj, checkpoint_trait, checkpoint_trait>(obj); | ||
auto s_info_d = checkpoint::serialize<TestObj, random_trait, checkpoint_trait>(obj); | ||
auto s_info_e = checkpoint::serialize<TestObj, checkpoint_trait, random_trait>(obj); | ||
auto s_info_f = checkpoint::serialize<TestObj, random_trait, random_trait>(obj); | ||
auto s_info_g = checkpoint::serialize<TestObj, shallow_trait>(obj); | ||
auto s_info_h = checkpoint::serialize<TestObj, misc::namespace_trait>(obj); | ||
auto s_info_i = checkpoint::serialize<TestObj, misc::hook_all_trait>(obj); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
#include "checkpoint/checkpoint.h" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing header here There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use |
||
|
||
struct checkpoint_trait {} CheckpointTrait; | ||
struct shallow_trait {} ShallowTrait; | ||
|
||
using checkpoint::has_user_traits_v; | ||
using checkpoint::has_any_user_traits_v; | ||
|
||
namespace test { | ||
struct random_trait {} RandomTrait; | ||
|
||
struct TestObj { | ||
Matthew-Whitlock marked this conversation as resolved.
Show resolved
Hide resolved
|
||
int a = 1; | ||
|
||
TestObj() {} | ||
|
||
template< | ||
typename SerT, | ||
typename std::enable_if_t< | ||
not has_user_traits_v<SerT, shallow_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s){ | ||
if constexpr(has_user_traits_v<SerT, checkpoint_trait>){ | ||
if(s.isSizing()) printf("Customizing serialization for checkpoint\n"); | ||
s | a; | ||
} else { | ||
if(s.isSizing()) printf("Default serializing testObj\n"); | ||
} | ||
|
||
static_assert(not has_user_traits_v<SerT, shallow_trait>, | ||
"ShallowTrait should have been removed!\n"); | ||
} | ||
}; | ||
} | ||
|
||
namespace test { | ||
template< | ||
typename SerT, | ||
typename std::enable_if_t< | ||
has_user_traits_v<SerT, random_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s, TestObj& myObj){ | ||
if(s.isSizing()){ | ||
printf("Inserting random extra object serialization step! "); | ||
} | ||
myObj.serialize(s); | ||
} | ||
|
||
template< | ||
typename SerT, | ||
typename std::enable_if_t< | ||
has_user_traits_v<SerT, shallow_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s, TestObj& myObj){ | ||
if(s.isSizing()) printf("Removing shallow trait before passing along!\n"); | ||
auto newS = s.template withoutTraits<shallow_trait>(); | ||
myObj.serialize(newS); | ||
} | ||
} | ||
|
||
namespace misc { | ||
template< | ||
typename SerT, | ||
typename std::enable_if_t< | ||
has_user_traits_v<SerT, test::random_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s, test::TestObj& myObj){ | ||
if(s.isSizing()){ | ||
printf("Serializers in other namespaces don't usually get found "); | ||
} | ||
myObj.serialize(s); | ||
} | ||
|
||
|
||
const struct namespace_trait {} NamespaceTrait; | ||
template< | ||
typename SerT, | ||
typename std::enable_if_t< | ||
has_user_traits_v<SerT, namespace_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s, test::TestObj& myObj){ | ||
if(s.isSizing()){ | ||
printf("A misc:: trait means we can serialize from misc:: too: "); | ||
} | ||
myObj.serialize(s); | ||
} | ||
|
||
|
||
const struct hook_all_trait {} HookAllTrait; | ||
template< | ||
typename SerT, | ||
typename T, | ||
typename std::enable_if_t< | ||
has_user_traits_v<SerT, hook_all_trait>, void* | ||
> = nullptr | ||
> | ||
void serialize(SerT& s, T& myObj){ | ||
if(s.isSizing()){ | ||
printf("We can even add on a generic pre-serialize hook: "); | ||
} | ||
auto newS = s.template withoutTraits<hook_all_trait>(); | ||
myObj.serialize(newS); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add as a documentation snippet