lumiera_documentation/src/common/query/query-resolver.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

121 lines
3.6 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.

/*
QueryResolver - interface for discovering contents of a scope
Copyright (C)
2009, 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 query-resolver.cpp
** implementation of a framework to query and discover elements
** based on logical rules. This framework builds on the notion of
** possibly having several QueryResolver facilities to handle various
** kinds of queries in an uniform way. To reflect that design, the
** implementation is built round a DispatcherTable to forward requests
** to concrete entities implementing the QueryResolver interface. The
** actual query resolution mechanism is thus not part of the framework.
**
*/
#include "lib/multifact.hpp"
#include "common/query/query-resolver.hpp"
namespace lumiera {
/* generate vtables here... */
Goal::~Goal() { }
Resolution::~Resolution() { }
QueryResolver::~QueryResolver() { }
typedef Goal::QueryID const& QID;
/* == dispatch to resolve typed queries == */
using lib::factory::BuildRefcountPtr;
using lib::factory::MultiFact;
/** factory used as dispatcher table
* for resolving typed queries */
typedef MultiFact< Resolution*(Goal const&) // raw signature of fabrication
, Goal::QueryID // select resolution function by kind-of-Query
, BuildRefcountPtr // wrapper: manage result set by smart-ptr
> DispatcherTable; //
/** PImpl of the generic QueryResolver */
class QueryDispatcher
: public DispatcherTable
{
public:
PReso
handle (Goal const& query)
{
QID qID = query.getQID();
ENSURE (contains (qID));
return this->invokeFactory (qID, query);
} // qID picks the resolution function
};
QueryResolver::QueryResolver ()
: dispatcher_(new QueryDispatcher)
{ }
/** @par implementation
* For actually building a result set, the QueryResolver base implementation
* uses an embedded dispatcher table. The concrete query resolving facilities,
* when implementing the QueryResolver interface, are expected to register
* individual resolution functions into this QueryDispatcher table.
* Whenever issuing a Goal, a suitable resolution function is picked
* based on the Goal::QueryID, which contains an embedded type code.
* Thus, the individual resolution function can (re)establish a
* typed context and downcast the Goal appropriately
*/
PReso
QueryResolver::issue (Goal const& query) const
{
REQUIRE (!dispatcher_->empty(), "attempt to issue a query without having installed any resolver (yet)");
if (!canHandle (query))
throw lumiera::error::Invalid ("unable to resolve this kind of query"); //////////////////////////////////TICKET #197
return dispatcher_->handle(query);
}
void
QueryResolver::installResolutionCase (QID qID, ResolutionMechanism resolutionFun)
{
ENSURE (!dispatcher_->contains (qID),
"duplicate registration of query resolution function");
dispatcher_->defineProduction (qID, resolutionFun);
}
} // namespace lumiera