lumiera_/tests/library/unique-malloc-owner-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

108 lines
3 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
UniqueMallocOwner(Test) - Concept to dispatch according to the verbs of a DSL
Copyright (C)
2014, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.
* *****************************************************************/
/** @file unique-malloc-owner-test.cpp
** unit test \ref UniqueMallocOwner_test
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "lib/unique-malloc-owner.hpp"
#include "lib/util.hpp"
#include <utility>
#include <cstring>
#include <string>
using std::string;
using util::isnil;
namespace lib {
namespace test{
namespace {
void*
mallocMess (size_t siz)
{
return malloc(siz);
}
}
/***************************************************************************//**
* @test Verify automatic management of memory originally allocated by C malloc.
* This situation typically arises when some plain-C function returns
* results in a heap allocated buffer, requiring the client to care
* for proper clean-up. To avoid creating a liability, we wrap the
* buffer into a smart pointer, which acts as ownership token
* and abstracts the specifics of clean-up.
*
* This test places a given (or random) string into a heap malloced
* buffer, and then pushes the "hot potato" of ownership responsibility
* around; another function checks the content of the buffer and consumes
* the token as a side-effect. At the end, there should be no memory leak
* and the ownership token should be empty.
*
* @see lib::UniqueMallocOwner
* @see lib::meta::demangleCxx
*/
class UniqueMallocOwner_test : public Test
{
using CharOwner = UniqueMallocOwner<char>;
virtual void
run (Arg args)
{
string probeString = isnil(args)? randStr(123) : args[0];
auto hotPotato = place_into_malloced_buffer (probeString);
CHECK (!isnil (hotPotato));
verify_and_consume (std::move(hotPotato), probeString);
CHECK (isnil (hotPotato));
}
CharOwner
place_into_malloced_buffer (string probeString)
{
CharOwner hotPotato(mallocMess (1 + probeString.length()));
std::strcpy(hotPotato.get(), probeString.c_str());
return hotPotato;
}
void
verify_and_consume (CharOwner hotPotato, string refString)
{
CHECK (refString == hotPotato.get());
} // note sideeffect: hotPotato goes out of scope here...
};
/** Register this test class... */
LAUNCHER (UniqueMallocOwner_test, "unit common");
}} // namespace lib::test