LUMIERA.clone/src/lib/query-text.cpp

/*
  QueryText  -  syntactical standard representation for queries

   Copyright (C)
     2012,            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-text.cpp
 ** Implementation bits regarding a syntactical standard representation of predicate queries
 */


#include "lib/query-text.hpp"

#include <boost/functional/hash.hpp>
#include <string>

using std::string;


namespace lib {
  
  
  /** Parse, verify and normalise the raw query definition
   * @warning right now (2012) we don't normalise at all
   * @todo when integrating a real resolution engine, we
   *       need to parse and verify the given string.
   */
  string
  QueryText::normalise (string const& rawDefinition)
  {
    return rawDefinition;
  }
  
  
  /** support using queries in hashtables. 
   * @warning right now (2012) the dummy implementation of QueryText
   *          doesn't normalise the query in any way, which makes the
   *          generated hash value dependent on the actual textual
   *          form used to build the QueryText. This is not how
   *          it's intended to work, it should rely on a normalised
   *          form after parsing the query definition.
   */
  HashVal
  hash_value (QueryText const& entry)
  {
    return boost::hash_value (entry.definition_);
  }
  

} // namespace lib
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
+								/*
 								  QueryText  -  syntactical standard representation for queries
-												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
+								   Copyright (C)
 ,            Hermann Vosseler <Ichthyostega@web.de>
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
-												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
+								  **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.
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
-												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
+								* *****************************************************************/
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
-												Doxygen: insert actual filename into those automatically added file comments

HOWTO
for F in $(find src -type f \( -name '*.cpp' -or -name '*.hpp' \)  -exec egrep -q '§§§' {} \; -print);
    do D=$(basename $F);
       sed -r -e"s/§§§/$D/" $F ;
done

											
										
										
											2016-11-03 18:22:31 +01:00
+								/** @file query-text.cpp
-												Doxygen: fill in missing file level headlines for the Library

											
										
										
											2016-11-08 13:18:05 +01:00
+								 ** Implementation bits regarding a syntactical standard representation of predicate queries
-												Doxygen: identify all files lacking a @file comment

reason is, only files with a @file comment will be processed
with further documentation commands. For this reason, our Doxygen
documentation is lacking a lot of entries.

HOWTO:
find src -type f \( -name '*.cpp' -or -name '*.hpp' \) -not -exec egrep -q '\*.+@file' {} \; -print -exec sed -i -r -e'\_\*/_,$ { 1,+0 a\
\
\
/** @file §§§\
 ** TODO §§§\
 */
}' {} \;

											
										
										
											2016-11-03 18:20:10 +01:00
+								 */
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
+								#include "lib/query-text.hpp"
 								#include <boost/functional/hash.hpp>
 								#include <string>
 								using std::string;
 								namespace lib {
-												integrate (placeholder) query definition

effectively this joins the two existing lines
of "Query" classes into one systematic representation
Next step would be to move all mutation operations
over to the Query::Builder

											
										
										
											2012-12-07 01:49:35 +01:00
+								  /** Parse, verify and normalise the raw query definition
 								   * @warning right now (2012) we don't normalise at all
 								   * @todo when integrating a real resolution engine, we
 								   *       need to parse and verify the given string.
 								   */
 								  string
 								  QueryText::normalise (string const& rawDefinition)
 								  {
 								    return rawDefinition;
 								  }
-												generic query representation (placeholder)

...planned to be replaced later by a real
AST based implementation, which acutally
parses the query definitions

											
										
										
											2012-12-03 00:41:57 +01:00
+								  /** support using queries in hashtables.
 								   * @warning right now (2012) the dummy implementation of QueryText
 								   *          doesn't normalise the query in any way, which makes the
 								   *          generated hash value dependent on the actual textual
 								   *          form used to build the QueryText. This is not how
 								   *          it's intended to work, it should rely on a normalised
 								   *          form after parsing the query definition.
 								   */
 								  HashVal
 								  hash_value (QueryText const& entry)
 								  {
 								    return boost::hash_value (entry.definition_);
 								  }
 								} // namespace lib