From b6df766e60e1a6239c836c825c224cefb1644bda Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Mon, 26 Dec 2016 03:48:17 +0100 Subject: [PATCH] Some documentation updates. --- docs/annotated.html | 8 +- docs/classes.html | 16 +- ...nal_1_1_keccak_impl_1_1sponge_state_struct.html | 112 -------- docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html | 100 ------- docs/d1/d37/_hash___blake2_8h_source.html | 81 ------ .../class_m_utils_1_1_hash_1_1_keccak-members.html | 96 ------- docs/d2/dad/_hash_8h.html | 297 +++++++++++++++++++++ docs/d2/dad/_hash_8h_source.html | 91 +++++++ .../class_m_utils_1_1_hash_1_1_hash-members.html | 89 ++++++ ...keccak_impl_1_1sponge_state_struct-members.html | 89 ------ docs/d5/d3b/_global_8h.html | 26 +- docs/d5/d3b/_global_8h_source.html | 2 +- docs/da/db0/class_m_utils_1_1_hash_1_1_hash.html | 271 +++++++++++++++++++ .../class_m_utils_1_1_hash_1_1_blake2-members.html | 86 ------ docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html | 130 --------- docs/dd/dea/_hash___keccak_8h_source.html | 82 ------ docs/dir_b076b53667bc06ebb413a190e197fc7b.html | 3 + docs/files.html | 25 +- docs/functions.html | 6 + docs/functions_func.html | 78 ++++++ docs/globals.html | 3 + docs/globals_defs.html | 3 + docs/hierarchy.html | 16 +- docs/index.html | 1 + docs/menudata.js | 1 + docs/search/all_10.js | 1 + docs/search/all_2.js | 1 - docs/search/all_3.js | 3 +- docs/search/all_4.js | 3 +- docs/search/all_7.js | 10 +- docs/search/all_8.js | 4 +- docs/search/all_9.js | 2 +- docs/search/all_a.js | 1 + docs/search/all_e.js | 1 - docs/search/classes_1.js | 2 +- docs/search/classes_4.js | 2 +- docs/search/classes_5.js | 2 +- docs/search/classes_6.js | 3 +- docs/search/classes_7.js | 2 +- docs/search/classes_8.js | 5 - docs/search/classes_9.js | 4 - docs/search/defines_0.js | 1 + docs/search/{classes_8.html => files_2.html} | 2 +- docs/search/files_2.js | 4 + docs/search/functions_1.js | 3 +- docs/search/functions_2.js | 3 +- docs/search/{classes_9.html => functions_9.html} | 2 +- docs/search/functions_9.js | 4 + docs/search/searchdata.js | 10 +- docs/search/variables_3.js | 6 +- docs/search/variables_4.js | 2 +- docs/search/variables_5.js | 2 +- docs/search/variables_6.js | 4 +- docs/search/variables_7.js | 4 +- docs/search/variables_8.html | 26 ++ docs/search/variables_8.js | 4 + include/MUtils/Global.h | 6 + include/MUtils/Hash.h | 80 +++++- include/MUtilsInfo.dox | 1 + 59 files changed, 1060 insertions(+), 862 deletions(-) delete mode 100644 docs/d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html delete mode 100644 docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html delete mode 100644 docs/d1/d37/_hash___blake2_8h_source.html delete mode 100644 docs/d1/d9c/class_m_utils_1_1_hash_1_1_keccak-members.html create mode 100644 docs/d2/dad/_hash_8h.html create mode 100644 docs/d2/dad/_hash_8h_source.html create mode 100644 docs/d2/ded/class_m_utils_1_1_hash_1_1_hash-members.html delete mode 100644 docs/d3/d35/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct-members.html create mode 100644 docs/da/db0/class_m_utils_1_1_hash_1_1_hash.html delete mode 100644 docs/dc/df9/class_m_utils_1_1_hash_1_1_blake2-members.html delete mode 100644 docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html delete mode 100644 docs/dd/dea/_hash___keccak_8h_source.html create mode 100644 docs/functions_func.html delete mode 100644 docs/search/classes_8.js delete mode 100644 docs/search/classes_9.js rename docs/search/{classes_8.html => files_2.html} (94%) create mode 100644 docs/search/files_2.js rename docs/search/{classes_9.html => functions_9.html} (93%) create mode 100644 docs/search/functions_9.js create mode 100644 docs/search/variables_8.html create mode 100644 docs/search/variables_8.js diff --git a/docs/annotated.html b/docs/annotated.html index 71f35f6..5c17dd8 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -64,16 +64,12 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 12345]
+
[detail level 1234]
- - - - - + diff --git a/docs/classes.html b/docs/classes.html index 81fc2fa..17d594a 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -63,7 +63,7 @@ $(function() {
Class Index
-
_ | b | i | j | k | r | s | t | u | v
+
_ | h | i | j | r | t | u | v
 ▼NMUtilsGlobal MUtils namespace
 ▼NCPUFetauresThis namespace contains functions and constants for detecting CPU information
 C_cpu_info_tStruct to hold information about the CPU. See _cpu_info_t for details!
 ▼NHash
 ▼NInternal
 ▼NKeccakImpl
 CspongeStateStruct
 CBlake2
 CKeccak
 CHashThis abstract class specifies the generic interface for all support hash algorithms
 ▼NOS
 ▼NVersion
 C_os_version_t
- - - - - + +
  _  
  i  
@@ -73,20 +73,16 @@ $(function() {
_cpu_info_t (MUtils::CPUFetaures)   IPCChannel (MUtils)   RegistryKey (MUtils::Registry)   UpdateChecker (MUtils)   
_os_version_t (MUtils::OS::Version)   
  j  
-
  s  
+
  t  
UpdateCheckerInfo (MUtils)   
  b  
+
  h  
  v  
JobObject (MUtils)   spongeStateStruct (MUtils::Hash::Internal::KeccakImpl)   
Blake2 (MUtils::Hash)   
  k  
-
  t  
-		Version (MUtils)   
Keccak (MUtils::Hash)   Taskbar7 (MUtils)   
JobObject (MUtils)   Taskbar7 (MUtils)   
Hash (MUtils::Hash)   Version (MUtils)   
-
_ | b | i | j | k | r | s | t | u | v
+
_ | h | i | j | r | t | u | v
diff --git a/docs/d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html b/docs/d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html deleted file mode 100644 index ff07b6e..0000000 --- a/docs/d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: MUtils::Hash::Internal::KeccakImpl::spongeStateStruct Struct Reference - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Attributes | -List of all members
-
-
MUtils::Hash::Internal::KeccakImpl::spongeStateStruct Struct Reference
-
-
- - - - - - - - - - - - - - - - - - -

-Public Attributes

-unsigned char state [(1600/8)]
 
-unsigned char dataQueue [(1536/8)]
 
-unsigned int rate
 
-unsigned int capacity
 
-unsigned int bitsInQueue
 
-unsigned int fixedOutputLength
 
-int squeezing
 
-unsigned int bitsAvailableForSqueezing
 
-
The documentation for this struct was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html b/docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html deleted file mode 100644 index 17c030c..0000000 --- a/docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: MUtils::Hash::Blake2 Class Reference - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -List of all members
-
-
MUtils::Hash::Blake2 Class Reference
-
-
- - - - - - - - - - -

-Public Member Functions

- Blake2 (const char *key=NULL)
 
-void update (const QByteArray &data)
 
-void update (QFile &file)
 
-QByteArray finalize (const bool bAsHex=true)
 
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/d1/d37/_hash___blake2_8h_source.html b/docs/d1/d37/_hash___blake2_8h_source.html deleted file mode 100644 index 3b2b644..0000000 --- a/docs/d1/d37/_hash___blake2_8h_source.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: include/MUtils/Hash_Blake2.h Source File - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Hash_Blake2.h
-
-
-
1 // Simple x264 Launcher
3 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This program is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation; either version 2 of the License, or
8 // (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License along
16 // with this program; if not, write to the Free Software Foundation, Inc.,
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 //
19 // http://www.gnu.org/licenses/gpl-2.0.txt
21 
22 /*
23  BLAKE2 reference source code package - reference C implementations
24 
25  Written in 2012 by Samuel Neves <sneves@dei.uc.pt>
26 
27  To the extent possible under law, the author(s) have dedicated all copyright
28  and related and neighboring rights to this software to the public domain
29  worldwide. This software is distributed without any warranty.
30 
31  You should have received a copy of the CC0 Public Domain Dedication along with
32  this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
33 */
34 
35 #pragma once
36 
37 //MUtils
38 #include <MUtils/Global.h>
39 
40 //Qt
41 #include <QByteArray>
42 #include <QFile>
43 
44 namespace MUtils
45 {
46  namespace Hash
47  {
48  class MUTILS_API Blake2_Context;
49 
50  class MUTILS_API Blake2
51  {
52  public:
53  Blake2(const char* key = NULL);
54  ~Blake2(void);
55 
56  void update(const QByteArray &data);
57  void update(QFile &file);
58  QByteArray finalize(const bool bAsHex = true);
59 
60  private:
61  QByteArray m_hash;
62  Blake2_Context *const m_context;
63  bool m_finalized;
64  };
65 
66  }
67 }
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
-
MUtils::Hash::Blake2
Definition: Hash_Blake2.h:50
-
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
-
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/d1/d9c/class_m_utils_1_1_hash_1_1_keccak-members.html b/docs/d1/d9c/class_m_utils_1_1_hash_1_1_keccak-members.html deleted file mode 100644 index a0914ea..0000000 --- a/docs/d1/d9c/class_m_utils_1_1_hash_1_1_keccak-members.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: Member List - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
MUtils::Hash::Keccak Member List
-
-
- -

This is the complete list of members for MUtils::Hash::Keccak, including all inherited members.

- - - - - - - - - - - - - - - - -
addData(const QByteArray &data) (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
addData(const char *data, int size) (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
finalize() (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
HashBits enum name (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
hb224 enum value (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
hb256 enum value (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
hb384 enum value (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
hb512 enum value (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
init(HashBits hashBits=hb256) (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
Keccak() (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
m_hashResult (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccakprotected
m_initialized (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccakprotected
m_state (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccakprotected
selfTest(void) (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccakstatic
~Keccak() (defined in MUtils::Hash::Keccak)MUtils::Hash::Keccak
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/d2/dad/_hash_8h.html b/docs/d2/dad/_hash_8h.html new file mode 100644 index 0000000..7345c28 --- /dev/null +++ b/docs/d2/dad/_hash_8h.html @@ -0,0 +1,297 @@ + + + + + + + +MuldeR's Utilities for Qt: include/MUtils/Hash.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
MuldeR's Utilities for Qt +
+
MUtilities
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Namespaces | +Functions | +Variables
+
+
Hash.h File Reference
+
+
+ +

This file contains function for cryptographic hash computation. +More...

+
#include <MUtils/Global.h>
+#include <QByteArray>
+#include <QFile>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  MUtils::Hash::Hash
 This abstract class specifies the generic interface for all support hash algorithms. More...
 
+ + + + +

+Namespaces

 MUtils
 Global MUtils namespace.
 
+ + + + +

+Functions

MUTILS_API Hash * MUtils::Hash::create (const quint16 &hashId, const char *const key=NULL)
 Create instance of a hash function. More...
 
+ + + + + + + + + + + + + + + + +

+Variables

static const quint16 MUtils::Hash::HASH_BLAKE2_512 = 0x0000U
 Hash algorithm identifier. More...
 
static const quint16 MUtils::Hash::HASH_KECCAK_224 = 0x0100U
 Hash algorithm identifier. More...
 
static const quint16 MUtils::Hash::HASH_KECCAK_256 = 0x0101U
 Hash algorithm identifier. More...
 
static const quint16 MUtils::Hash::HASH_KECCAK_384 = 0x0102U
 Hash algorithm identifier. More...
 
static const quint16 MUtils::Hash::HASH_KECCAK_512 = 0x0103U
 Hash algorithm identifier. More...
 
+

Detailed Description

+

This file contains function for cryptographic hash computation.

+

Call the MUtils::Hash::create() function to create an instance of the desired hash function. All Hash functions implement the MUtils::Hash::Hash interface.

+

Function Documentation

+ +

§ create()

+ +
+
+ + + + + + + + + + + + + + + + + + +
MUTILS_API Hash* MUtils::Hash::create (const quint16 & hashId,
const char *const key = NULL 
)
+
+ +

Create instance of a hash function.

+

This function is used to create a new instance of the desired hash function. All Hash functions implement the MUtils::Hash::Hash interface. The caller is responsible for destroying the returned MUtils::Hash::Hash object.

+
Parameters
+ + + +
hashIdSpecifies the desired hash function. This must be a valid hash algorithm identifier, as defined in the Hash.h header file.
keySpecifies on optional key that is used to "seed" the hash function. If a key is given, it must be a NULL-terminated string of appropriate length. If set to NULL, the optional seeding is skipped.
+
+
+
Returns
Returns a pointer to a new MUtils::Hash::Hash object that implements the desired hash function. The function throws if an invalid algorithm identifier was specified!
+ +
+
+

Variable Documentation

+ +

§ HASH_BLAKE2_512

+ +
+
+ + + + + +
+ + + + +
const quint16 MUtils::Hash::HASH_BLAKE2_512 = 0x0000U
+ 		+static
+
+ +

Hash algorithm identifier.

+

Use BLAKE2 hash algorithm, with a length of 512-Bit.

+ +
+
+ +

§ HASH_KECCAK_224

+ +
+
+ + + + + +
+ + + + +
const quint16 MUtils::Hash::HASH_KECCAK_224 = 0x0100U
+ 		+static
+
+ +

Hash algorithm identifier.

+

Use Keccak (SHA-3) hash algorithm, with a length of 224-Bit.

+ +
+
+ +

§ HASH_KECCAK_256

+ +
+
+ + + + + +
+ + + + +
const quint16 MUtils::Hash::HASH_KECCAK_256 = 0x0101U
+ 		+static
+
+ +

Hash algorithm identifier.

+

Use Keccak (SHA-3) hash algorithm, with a length of 256-Bit.

+ +
+
+ +

§ HASH_KECCAK_384

+ +
+
+ + + + + +
+ + + + +
const quint16 MUtils::Hash::HASH_KECCAK_384 = 0x0102U
+ 		+static
+
+ +

Hash algorithm identifier.

+

Use Keccak (SHA-3) hash algorithm, with a length of 384-Bit.

+ +
+
+ +

§ HASH_KECCAK_512

+ +
+
+ + + + + +
+ + + + +
const quint16 MUtils::Hash::HASH_KECCAK_512 = 0x0103U
+ 		+static
+
+ +

Hash algorithm identifier.

+

Use Keccak (SHA-3) hash algorithm, with a length of 512-Bit.

+ +
+
+
+ +
+Generated by   +doxygen + 1.8.12 +
+ + diff --git a/docs/d2/dad/_hash_8h_source.html b/docs/d2/dad/_hash_8h_source.html new file mode 100644 index 0000000..76f5ca8 --- /dev/null +++ b/docs/d2/dad/_hash_8h_source.html @@ -0,0 +1,91 @@ + + + + + + + +MuldeR's Utilities for Qt: include/MUtils/Hash.h Source File + + + + + + + + + +
+
+ + + + + + +
+
MuldeR's Utilities for Qt +
+
MUtilities
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hash.h
+
+
+Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
29 #pragma once
30 
31 //MUtils
32 #include <MUtils/Global.h>
33 
34 //Qt
35 #include <QByteArray>
36 #include <QFile>
37 
38 namespace MUtils
39 {
40  namespace Hash
41  {
42  static const quint16 HASH_BLAKE2_512 = 0x0000U;
43  static const quint16 HASH_KECCAK_224 = 0x0100U;
44  static const quint16 HASH_KECCAK_256 = 0x0101U;
45  static const quint16 HASH_KECCAK_384 = 0x0102U;
46  static const quint16 HASH_KECCAK_512 = 0x0103U;
47 
57  class MUTILS_API Hash
58  {
59  public:
60  virtual ~Hash(void) {};
61 
73  bool update(const quint8 *const data, const quint32 len) { return process(data, len); }
74 
84  bool update(const QByteArray &data) { return process(((const quint8*)data.constData()), ((quint32)data.length())); }
85 
95  bool update(QFile &file);
96 
106  QByteArray digest(const bool bAsHex = true) { return bAsHex ? finalize().toHex() : finalize(); }
107 
108  protected:
109  Hash(const char* key = NULL) {/*nothing to do*/};
110  virtual bool process(const quint8 *const data, const quint32 len) = 0;
111  virtual QByteArray finalize(void) = 0;
112 
113  private:
114  MUTILS_NO_COPY(Hash);
115  };
116 
128  MUTILS_API Hash *create(const quint16 &hashId, const char *const key = NULL);
129  }
130 }
MUtils::Hash::Hash::update
bool update(const QByteArray &data)
Process the next chunk of input data.
Definition: Hash.h:84
+
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
+
MUtils::Hash::Hash::update
bool update(const quint8 *const data, const quint32 len)
Process the next chunk of input data.
Definition: Hash.h:73
+
MUtils::Hash::HASH_BLAKE2_512
static const quint16 HASH_BLAKE2_512
Hash algorithm identifier.
Definition: Hash.h:42
+
MUtils::Hash::HASH_KECCAK_384
static const quint16 HASH_KECCAK_384
Hash algorithm identifier.
Definition: Hash.h:45
+
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
+
MUTILS_NO_COPY
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:362
+
MUtils::Hash::create
MUTILS_API Hash * create(const quint16 &hashId, const char *const key=NULL)
Create instance of a hash function.
+
MUtils::Hash::Hash
This abstract class specifies the generic interface for all support hash algorithms.
Definition: Hash.h:57
+
MUtils::Hash::HASH_KECCAK_256
static const quint16 HASH_KECCAK_256
Hash algorithm identifier.
Definition: Hash.h:44
+
MUtils::Hash::HASH_KECCAK_224
static const quint16 HASH_KECCAK_224
Hash algorithm identifier.
Definition: Hash.h:43
+
MUtils::Hash::Hash::digest
QByteArray digest(const bool bAsHex=true)
Retrieve the hash value.
Definition: Hash.h:106
+
MUtils::Hash::HASH_KECCAK_512
static const quint16 HASH_KECCAK_512
Hash algorithm identifier.
Definition: Hash.h:46
+
+ +
+Generated by   +doxygen + 1.8.12 +
+ + diff --git a/docs/d2/ded/class_m_utils_1_1_hash_1_1_hash-members.html b/docs/d2/ded/class_m_utils_1_1_hash_1_1_hash-members.html new file mode 100644 index 0000000..dba278b --- /dev/null +++ b/docs/d2/ded/class_m_utils_1_1_hash_1_1_hash-members.html @@ -0,0 +1,89 @@ + + + + + + + +MuldeR's Utilities for Qt: Member List + + + + + + + + + +
+
+ + + + + + +
+
MuldeR's Utilities for Qt +
+
MUtilities
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
MUtils::Hash::Hash Member List
+
+
+ +

This is the complete list of members for MUtils::Hash::Hash, including all inherited members.

+ + + + + + + + + +
digest(const bool bAsHex=true)MUtils::Hash::Hashinline
finalize(void)=0 (defined in MUtils::Hash::Hash)MUtils::Hash::Hashprotectedpure virtual
Hash(const char *key=NULL) (defined in MUtils::Hash::Hash)MUtils::Hash::Hashinlineprotected
process(const quint8 *const data, const quint32 len)=0 (defined in MUtils::Hash::Hash)MUtils::Hash::Hashprotectedpure virtual
update(const quint8 *const data, const quint32 len)MUtils::Hash::Hashinline
update(const QByteArray &data)MUtils::Hash::Hashinline
update(QFile &file)MUtils::Hash::Hash
~Hash(void) (defined in MUtils::Hash::Hash)MUtils::Hash::Hashinlinevirtual
+ +
+Generated by   +doxygen + 1.8.12 +
+ + diff --git a/docs/d3/d35/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct-members.html b/docs/d3/d35/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct-members.html deleted file mode 100644 index 15e97e3..0000000 --- a/docs/d3/d35/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct-members.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: Member List - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
MUtils::Hash::Internal::KeccakImpl::spongeStateStruct Member List
-
-
- -

This is the complete list of members for MUtils::Hash::Internal::KeccakImpl::spongeStateStruct, including all inherited members.

- - - - - - - - - -
bitsAvailableForSqueezing (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
bitsInQueue (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
capacity (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
dataQueue (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
fixedOutputLength (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
rate (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
squeezing (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
state (defined in MUtils::Hash::Internal::KeccakImpl::spongeStateStruct)MUtils::Hash::Internal::KeccakImpl::spongeStateStruct
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/d5/d3b/_global_8h.html b/docs/d5/d3b/_global_8h.html index 03c04a3..a24e410 100644 --- a/docs/d5/d3b/_global_8h.html +++ b/docs/d5/d3b/_global_8h.html @@ -114,6 +114,9 @@ Macros #define MUTILS_BOOL2STR(X)   ((X) ? "1" : "0")  Converts a boolean expression into a string. A true boolean expression is converted to the string "1"; a false boolean expression is converted to the string "0".
  +#define MUTILS_NO_COPY(CLASS) + Disables copy constructor and assignment operator in the specified class. This macro should be used in the "private" section of the class' declaration. More...
+  @@ -180,7 +183,28 @@ Functions

Functions

Detailed Description

This file contains miscellaneous functions that are generally useful for Qt-based applications.

-
+

Macro Definition Documentation

+ +

§ MUTILS_NO_COPY

+ +
+
+ + + + + + + + +
#define MUTILS_NO_COPY( CLASS)
+
+Value:
CLASS(const CLASS &) { throw "Copy constructor is disabled!"; } \
CLASS &operator=(const CLASS &) { throw "Assignment operator is disabled!"; }
+

Disables copy constructor and assignment operator in the specified class. This macro should be used in the "private" section of the class' declaration.

+ +
+
+
Generated by   diff --git a/docs/d5/d3b/_global_8h_source.html b/docs/d5/d3b/_global_8h_source.html index 33a91a6..bd5adba 100644 --- a/docs/d5/d3b/_global_8h_source.html +++ b/docs/d5/d3b/_global_8h_source.html @@ -67,7 +67,7 @@ $(function() {
Global.h
-Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
27 #pragma once
28 
29 #include <QString>
30 
31 //Forward Declarations
32 class QProcess;
33 
35 
39 //MUtils API
40 #ifdef _MSC_VER
41 # ifdef MUTILS_DLL_EXPORT
42 # define MUTILS_API __declspec(dllexport)
43 # else
44 # ifndef MUTILS_STATIC_LIB
45 # define MUTILS_API __declspec(dllimport)
46 # else
47 # define MUTILS_API /*static lib*/
48 # endif
49 # endif
50 #else
51 # define MUTILS_API
52 #endif
53 
54 #define MUTILS_MAKE_STRING_HELPER(X) #X
55 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
56 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
57 
58 //Check Debug Flags
59 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
60 # define MUTILS_DEBUG (1)
61 # if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
62 # error Inconsistent DEBUG flags have been detected!
63 # endif
64 #else
65 # define MUTILS_DEBUG (0)
66 # if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
67 # error Inconsistent DEBUG flags have been detected!
68 # endif
69 #endif
70 
71 //Check CPU options
72 #if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)
73  #if (_M_IX86_FP != 0)
74  #error We should not enabled SSE or SSE2 in release builds!
75  #endif
76 #endif
77 
81 
86 namespace MUtils
87 {
95  MUTILS_API const QString& temp_folder(void);
96 
110  MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
111 
119  MUTILS_API quint32 next_rand_u32(void);
120 
128  MUTILS_API quint64 next_rand_u64(void);
129 
139  MUTILS_API QString next_rand_str(const bool &bLong = false);
140 
154  MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
155 
171  MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
172 
180  MUTILS_API bool parity(quint32 value);
181 
191  MUTILS_API bool remove_file(const QString &fileName);
192 
204  MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
205 
215  MUTILS_API QString& trim_right(QString &str);
216 
226  MUTILS_API QString& trim_left(QString &str);
227 
237  MUTILS_API QString trim_right(const QString &str);
238 
248  MUTILS_API QString trim_left(const QString &str);
249 
259  MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
260 
270  MUTILS_API QString clean_file_name(const QString &name);
271 
281  MUTILS_API QString clean_file_path(const QString &path);
282 
294  MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
295 
309  MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
310 
320  MUTILS_API QStringList available_codepages(const bool &noAliases = true);
321 
322  //Internal
323  namespace Internal
324  {
325  MUTILS_API int selfTest(const char *const buildKey, const bool debug);
326  static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
327  }
328 }
329 
331 
334 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
335 
338 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
339 
342 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
343 
346 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
347 
350 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
351 
354 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
355 
358 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")
MUtils::available_codepages
MUTILS_API QStringList available_codepages(const bool &noAliases=true)
Retrieve a list of all available codepages.
+Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
27 #pragma once
28 
29 #include <QString>
30 
31 //Forward Declarations
32 class QProcess;
33 
35 
39 //MUtils API
40 #ifdef _MSC_VER
41 # ifdef MUTILS_DLL_EXPORT
42 # define MUTILS_API __declspec(dllexport)
43 # else
44 # ifndef MUTILS_STATIC_LIB
45 # define MUTILS_API __declspec(dllimport)
46 # else
47 # define MUTILS_API /*static lib*/
48 # endif
49 # endif
50 #else
51 # define MUTILS_API
52 #endif
53 
54 #define MUTILS_MAKE_STRING_HELPER(X) #X
55 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
56 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
57 
58 //Check Debug Flags
59 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
60 # define MUTILS_DEBUG (1)
61 # if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
62 # error Inconsistent DEBUG flags have been detected!
63 # endif
64 #else
65 # define MUTILS_DEBUG (0)
66 # if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
67 # error Inconsistent DEBUG flags have been detected!
68 # endif
69 #endif
70 
71 //Check CPU options
72 #if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)
73  #if (_M_IX86_FP != 0)
74  #error We should not enabled SSE or SSE2 in release builds!
75  #endif
76 #endif
77 
81 
86 namespace MUtils
87 {
95  MUTILS_API const QString& temp_folder(void);
96 
110  MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
111 
119  MUTILS_API quint32 next_rand_u32(void);
120 
128  MUTILS_API quint64 next_rand_u64(void);
129 
139  MUTILS_API QString next_rand_str(const bool &bLong = false);
140 
154  MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
155 
171  MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
172 
180  MUTILS_API bool parity(quint32 value);
181 
191  MUTILS_API bool remove_file(const QString &fileName);
192 
204  MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
205 
215  MUTILS_API QString& trim_right(QString &str);
216 
226  MUTILS_API QString& trim_left(QString &str);
227 
237  MUTILS_API QString trim_right(const QString &str);
238 
248  MUTILS_API QString trim_left(const QString &str);
249 
259  MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
260 
270  MUTILS_API QString clean_file_name(const QString &name);
271 
281  MUTILS_API QString clean_file_path(const QString &path);
282 
294  MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
295 
309  MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
310 
320  MUTILS_API QStringList available_codepages(const bool &noAliases = true);
321 
322  //Internal
323  namespace Internal
324  {
325  MUTILS_API int selfTest(const char *const buildKey, const bool debug);
326  static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
327  }
328 }
329 
331 
334 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
335 
338 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
339 
342 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
343 
346 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
347 
350 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
351 
354 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
355 
358 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")
359 
362 #define MUTILS_NO_COPY(CLASS) \
363  CLASS(const CLASS &) { throw "Copy constructor is disabled!"; } \
364  CLASS &operator=(const CLASS &) { throw "Assignment operator is disabled!"; }
MUtils::available_codepages
MUTILS_API QStringList available_codepages(const bool &noAliases=true)
Retrieve a list of all available codepages.
MUtils::next_rand_str
MUTILS_API QString next_rand_str(const bool &bLong=false)
Generates a random string.
MUtils::remove_file
MUTILS_API bool remove_file(const QString &fileName)
Deletes the specified file.
MUtils::natural_string_sort
MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase)
Sort a list of strings using "natural ordering" algorithm.
diff --git a/docs/da/db0/class_m_utils_1_1_hash_1_1_hash.html b/docs/da/db0/class_m_utils_1_1_hash_1_1_hash.html new file mode 100644 index 0000000..50e03fc --- /dev/null +++ b/docs/da/db0/class_m_utils_1_1_hash_1_1_hash.html @@ -0,0 +1,271 @@ + + + + + + + +MuldeR's Utilities for Qt: MUtils::Hash::Hash Class Reference + + + + + + + + + +
+
+ + + + + + +
+
MuldeR's Utilities for Qt +
+
MUtilities
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
MUtils::Hash::Hash Class Referenceabstract
+
+
+ +

This abstract class specifies the generic interface for all support hash algorithms. + More...

+ +

#include <Hash.h>

+ + + + + + + + + + + + + + +

+Public Member Functions

bool update (const quint8 *const data, const quint32 len)
 Process the next chunk of input data. More...
 
bool update (const QByteArray &data)
 Process the next chunk of input data. More...
 
bool update (QFile &file)
 Process the next chunk of input data. More...
 
QByteArray digest (const bool bAsHex=true)
 Retrieve the hash value. More...
 
+ + + + + + + +

+Protected Member Functions

+ Hash (const char *key=NULL)
 
+virtual bool process (const quint8 *const data, const quint32 len)=0
 
+virtual QByteArray finalize (void)=0
 
+

Detailed Description

+

This abstract class specifies the generic interface for all support hash algorithms.

+

In order to compute a hash value (digest) call the the Hash::update() function repeatedly until all input data (i.e. the complete "message") has been processed. Then call the Hash::digest() function to retrieve the final hash value.

+

All overloads of the Hash::update() function may be called in an interleaved fashion as needed.

+

This class is not thread-safe, i.e. do not call the same Hash instance from difference threads, unless serialization is ensured (e.g. by means of a Mutex). It is safe, however, to call different different Hash instances from difference threads concurrently.

+

Member Function Documentation

+ +

§ digest()

+ +
+
+ + + + + +
+ + + + + + + + +
QByteArray MUtils::Hash::Hash::digest (const bool bAsHex = true)
+ 		+inline
+
+ +

Retrieve the hash value.

+

This function is used to retrieve the final hash value (digest), after all input data has been processed successfully.

+
Parameters
+ + +
bAsHexIf set to true, the function returns the hash value as a Hexadecimal-encoded ASCII string; if set to false, the function returns the hash value as "raw" bytes.
+
+
+
Returns
The function returns a QByteArray object holding the final hash value (digest). The format depends on the bAsHex parameter.
+ +
+
+ +

§ update() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool MUtils::Hash::Hash::update (const quint8 *const data,
const quint32 len 
)
+ 		+inline
+
+ +

Process the next chunk of input data.

+

Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.

+
Parameters
+ + + +
dataA read-only pointer to the memory buffer holding the input data to be processed.
lenThe length of the input data, in bytes. The data parameter must be pointing to a memory buffer that is at least len bytes in size.
+
+
+
Returns
The function returns true, if the input data was processed successfully; otherwise it returns false.
+ +
+
+ +

§ update() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
bool MUtils::Hash::Hash::update (const QByteArray & data)
+ 		+inline
+
+ +

Process the next chunk of input data.

+

Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.

+
Parameters
+ + +
dataA read-only reference to a QByteArray object holding the input data to be processed. All bytes in the QByteArray object will be processed.
+
+
+
Returns
The function returns true, if the input data was processed successfully; otherwise it returns false.
+ +
+
+ +

§ update() [3/3]

+ +
+
+ + + + + + + + +
bool MUtils::Hash::Hash::update (QFile & file)
+
+ +

Process the next chunk of input data.

+

Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.

+
Parameters
+ + +
dataA reference to a QFile object. The QFile object must be open and readable. All data from the current file position to the end of the file will be processed.
+
+
+
Returns
The function returns true, if all data in the file was processed successfully; otherwise (e.g. in case of file read errors) it returns false.
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.12 +
+ + diff --git a/docs/dc/df9/class_m_utils_1_1_hash_1_1_blake2-members.html b/docs/dc/df9/class_m_utils_1_1_hash_1_1_blake2-members.html deleted file mode 100644 index d12d715..0000000 --- a/docs/dc/df9/class_m_utils_1_1_hash_1_1_blake2-members.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: Member List - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
MUtils::Hash::Blake2 Member List
-
-
- -

This is the complete list of members for MUtils::Hash::Blake2, including all inherited members.

- - - - - - -
Blake2(const char *key=NULL) (defined in MUtils::Hash::Blake2)MUtils::Hash::Blake2
finalize(const bool bAsHex=true) (defined in MUtils::Hash::Blake2)MUtils::Hash::Blake2
update(const QByteArray &data) (defined in MUtils::Hash::Blake2)MUtils::Hash::Blake2
update(QFile &file) (defined in MUtils::Hash::Blake2)MUtils::Hash::Blake2
~Blake2(void) (defined in MUtils::Hash::Blake2)MUtils::Hash::Blake2
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html b/docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html deleted file mode 100644 index a582eec..0000000 --- a/docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: MUtils::Hash::Keccak Class Reference - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Types | -Public Member Functions | -Static Public Member Functions | -Protected Attributes | -List of all members
-
-
MUtils::Hash::Keccak Class Reference
-
-
- - - - -

-Public Types

enum  HashBits { hb224, -hb256, -hb384, -hb512 - }
 
- - - - - - - - - -

-Public Member Functions

-bool init (HashBits hashBits=hb256)
 
-bool addData (const QByteArray &data)
 
-bool addData (const char *data, int size)
 
-const QByteArray & finalize ()
 
- - - -

-Static Public Member Functions

-static bool selfTest (void)
 
- - - - - - - -

-Protected Attributes

-bool m_initialized
 
-Internal::KeccakImpl::hashState * m_state
 
-QByteArray m_hashResult
 
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/dd/dea/_hash___keccak_8h_source.html b/docs/dd/dea/_hash___keccak_8h_source.html deleted file mode 100644 index 4667373..0000000 --- a/docs/dd/dea/_hash___keccak_8h_source.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - -MuldeR's Utilities for Qt: include/MUtils/Hash_Keccak.h Source File - - - - - - - - - -
-
- - - - - - -
-
MuldeR's Utilities for Qt -
-
MUtilities
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Hash_Keccak.h
-
-
-
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
22 /***************************************************************************
23 ** **
24 ** QKeccakHash, an API wrapper bringing the optimized implementation of **
25 ** Keccak (http://keccak.noekeon.org/) to Qt. **
26 ** Copyright (C) 2013 Emanuel Eichhammer **
27 ** **
28 ** This program is free software: you can redistribute it and/or modify **
29 ** it under the terms of the GNU General Public License as published by **
30 ** the Free Software Foundation, either version 3 of the License, or **
31 ** (at your option) any later version. **
32 ** **
33 ** This program is distributed in the hope that it will be useful, **
34 ** but WITHOUT ANY WARRANTY; without even the implied warranty of **
35 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the **
36 ** GNU General Public License for more details. **
37 ** **
38 ** You should have received a copy of the GNU General Public License **
39 ** along with this program. If not, see http://www.gnu.org/licenses/. **
40 ** **
41 ****************************************************************************
42 ** Author: Emanuel Eichhammer **
43 ** Website/Contact: http://www.WorksLikeClockwork.com/ **
44 ** Date: 12.01.12 **
45 ****************************************************************************/
46 
47 #pragma once
48 
49 //MUtils
50 #include <MUtils/Global.h>
51 
52 //Qt
53 #include <QString>
54 #include <QByteArray>
55 #include <QFile>
56 
57 namespace MUtils
58 {
59  namespace Hash
60  {
61  namespace Internal
62  {
63  // Section from KeccakSponge.h
64  // needed here, since hashState needs to be explicitly 32-byte aligned and therefore can't be
65  // transformed into a class (in order to forward declarate) like in the other hash wrappers.
66  namespace KeccakImpl
67  {
68  #define KeccakPermutationSize 1600
69  #define KeccakPermutationSizeInBytes (KeccakPermutationSize/8)
70  #define KeccakMaximumRate 1536
71  #define KeccakMaximumRateInBytes (KeccakMaximumRate/8)
72 
73  #if defined(__GNUC__)
74  #define ALIGN __attribute__ ((aligned(32)))
75  #elif defined(_MSC_VER)
76  #define ALIGN __declspec(align(32))
77  #else
78  #define ALIGN
79  #endif
80 
81  ALIGN typedef struct spongeStateStruct
82  {
83  ALIGN unsigned char state[KeccakPermutationSizeInBytes];
84  ALIGN unsigned char dataQueue[KeccakMaximumRateInBytes];
85  unsigned int rate;
86  unsigned int capacity;
87  unsigned int bitsInQueue;
88  unsigned int fixedOutputLength;
89  int squeezing;
90  unsigned int bitsAvailableForSqueezing;
91  }
92  spongeState;
93  typedef spongeState hashState;
94  }
95  // End Section from KeccakSponge.h
96  }
97 
98  class MUTILS_API Keccak
99  {
100  public:
101  enum HashBits {hb224, hb256, hb384, hb512};
102 
103  Keccak();
104  ~Keccak();
105 
106  static bool selfTest(void);
107 
108  bool init(HashBits hashBits=hb256);
109  bool addData(const QByteArray &data);
110  bool addData(const char *data, int size);
111  const QByteArray &finalize();
112 
113  protected:
114  bool m_initialized;
115  Internal::KeccakImpl::hashState *m_state;
116  QByteArray m_hashResult;
117  };
118  }
119 };
MUtils::Hash::Keccak
Definition: Hash_Keccak.h:98
-
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
- -
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
-
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/dir_b076b53667bc06ebb413a190e197fc7b.html b/docs/dir_b076b53667bc06ebb413a190e197fc7b.html index 41da400..93eb456 100644 --- a/docs/dir_b076b53667bc06ebb413a190e197fc7b.html +++ b/docs/dir_b076b53667bc06ebb413a190e197fc7b.html @@ -76,6 +76,9 @@ Files file  Global.h [code]  This file contains miscellaneous functions that are generally useful for Qt-based applications.
  +file  Hash.h [code] + This file contains function for cryptographic hash computation.
+ 
diff --git a/docs/files.html b/docs/files.html index 554fdaf..97c20a6 100644 --- a/docs/files.html +++ b/docs/files.html @@ -72,19 +72,18 @@ $(function() {  Exception.h  Global.hThis file contains miscellaneous functions that are generally useful for Qt-based applications  GUI.h - Hash_Blake2.h - Hash_Keccak.h - IPCChannel.h - JobObject.h - OSSupport.h - Registry.h - Sound.h - Startup.h - Taskbar7.h - Terminal.h - Translation.h - UpdateChecker.h - Version.h + Hash.hThis file contains function for cryptographic hash computation + IPCChannel.h + JobObject.h + OSSupport.h + Registry.h + Sound.h + Startup.h + Taskbar7.h + Terminal.h + Translation.h + UpdateChecker.h + Version.h
diff --git a/docs/functions.html b/docs/functions.html index 4b3e981..01730b7 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -66,6 +66,9 @@ $(function() {
  • count : MUtils::CPUFetaures::_cpu_info_t
    • +
  • digest() +: MUtils::Hash::Hash +
  • family : MUtils::CPUFetaures::_cpu_info_t
    • @@ -81,6 +84,9 @@ $(function() {
  • stepping : MUtils::CPUFetaures::_cpu_info_t
    • +
  • update() +: MUtils::Hash::Hash +
  • vendor : MUtils::CPUFetaures::_cpu_info_t
    • diff --git a/docs/functions_func.html b/docs/functions_func.html new file mode 100644 index 0000000..eabd5f0 --- /dev/null +++ b/docs/functions_func.html @@ -0,0 +1,78 @@ + + + + + + + +MuldeR's Utilities for Qt: Class Members - Functions + + + + + + + + + +
    +
    + + + + + + +
    +
    MuldeR's Utilities for Qt +
    +
    MUtilities
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +  +
    + +
    +Generated by   +doxygen + 1.8.12 +
    + + diff --git a/docs/globals.html b/docs/globals.html index 79292d5..e130e9b 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -69,6 +69,9 @@ $(function() {
  • MUTILS_DELETE_ARRAY : Global.h
    • +
  • MUTILS_NO_COPY +: Global.h +
  • MUTILS_QSTR : Global.h
    • diff --git a/docs/globals_defs.html b/docs/globals_defs.html index 1ac0620..c0c9271 100644 --- a/docs/globals_defs.html +++ b/docs/globals_defs.html @@ -69,6 +69,9 @@ $(function() {
  • MUTILS_DELETE_ARRAY : Global.h
    • +
  • MUTILS_NO_COPY +: Global.h +
  • MUTILS_QSTR : Global.h
    • diff --git a/docs/hierarchy.html b/docs/hierarchy.html index b7d4b7b..6d3bd03 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -67,17 +67,15 @@ $(function() {
    [detail level 12]
    - + - - - - - - - - + + + + + +
     CMUtils::CPUFetaures::_cpu_info_tStruct to hold information about the CPU. See _cpu_info_t for details!
     CMUtils::OS::Version::_os_version_t
     CMUtils::Hash::Blake2
     CMUtils::Hash::HashThis abstract class specifies the generic interface for all support hash algorithms
     CMUtils::IPCChannel
     CMUtils::JobObject
     CMUtils::Hash::Keccak
     ▼CQThread
     CMUtils::UpdateChecker
     CMUtils::Registry::RegistryKey
     CMUtils::Hash::Internal::KeccakImpl::spongeStateStruct
     CMUtils::Taskbar7
     CMUtils::UpdateCheckerInfo
     CMUtils::Version
     ▼CQThread
     CMUtils::UpdateChecker
     CMUtils::Registry::RegistryKey
     CMUtils::Taskbar7
     CMUtils::UpdateCheckerInfo
     CMUtils::Version
    diff --git a/docs/index.html b/docs/index.html index d74a69c..039efdc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -69,6 +69,7 @@ $(function() {

    The public API of the MUtilities library is defined in the following header files (select file for details):

    • Global.h – miscellaneous useful functions
    • CPUFeatures.h – functions for detection information about the CPU
      • +
    • Hash.h – functions for cryptographic hash computation

    Example

    Here is a minimal example on how to use the MUtilities library in your project: 

    //MUtils
diff --git a/docs/menudata.js b/docs/menudata.js
index 0d48979..9af163f 100644
--- a/docs/menudata.js
+++ b/docs/menudata.js
@@ -24,6 +24,7 @@ var menudata={children:[
 {text:'Class Hierarchy',url:'hierarchy.html'},
 {text:'Class Members',url:'functions.html',children:[
 {text:'All',url:'functions.html'},
+{text:'Functions',url:'functions_func.html'},
 {text:'Variables',url:'functions_vars.html'}]}]},
 {text:'Files',url:'files.html',children:[
 {text:'File List',url:'files.html'},
diff --git a/docs/search/all_10.js b/docs/search/all_10.js
index d8e4d05..e8012eb 100644
--- a/docs/search/all_10.js
+++ b/docs/search/all_10.js
@@ -1,5 +1,6 @@
 var searchData=
 [
+  ['update',['update',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a5c36bd2ea671928f9f5bd897dcfbef15',1,'MUtils::Hash::Hash::update(const quint8 *const data, const quint32 len)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a16bef08766de745913b3fd7c338bf5aa',1,'MUtils::Hash::Hash::update(const QByteArray &data)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#ace90c97585350dd246b6c655a3de571f',1,'MUtils::Hash::Hash::update(QFile &file)']]],
   ['updatechecker',['UpdateChecker',['../d0/d8a/class_m_utils_1_1_update_checker.html',1,'MUtils']]],
   ['updatecheckerinfo',['UpdateCheckerInfo',['../d1/d0d/class_m_utils_1_1_update_checker_info.html',1,'MUtils']]]
 ];
diff --git a/docs/search/all_2.js b/docs/search/all_2.js
index 94fe2bd..a0ea208 100644
--- a/docs/search/all_2.js
+++ b/docs/search/all_2.js
@@ -1,5 +1,4 @@
 var searchData=
 [
-  ['blake2',['Blake2',['../d1/d01/class_m_utils_1_1_hash_1_1_blake2.html',1,'MUtils::Hash']]],
   ['brand',['brand',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a2986daa8c1b524a7f952eacb8d516696',1,'MUtils::CPUFetaures::_cpu_info_t']]]
 ];
diff --git a/docs/search/all_3.js b/docs/search/all_3.js
index 738f52c..53083cf 100644
--- a/docs/search/all_3.js
+++ b/docs/search/all_3.js
@@ -4,5 +4,6 @@ var searchData=
   ['clean_5ffile_5fpath',['clean_file_path',['../d3/da6/namespace_m_utils.html#ad801fab93087c31d764ad15295fe3a88',1,'MUtils']]],
   ['count',['count',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a7861529c47568141daa37810ebb499ea',1,'MUtils::CPUFetaures::_cpu_info_t']]],
   ['cpu_5finfo_5ft',['cpu_info_t',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a8b80fb34713dbc70a63ae5cd48b0630e',1,'MUtils::CPUFetaures']]],
-  ['cpufeatures_2eh',['CPUFeatures.h',['../d2/db5/_c_p_u_features_8h.html',1,'']]]
+  ['cpufeatures_2eh',['CPUFeatures.h',['../d2/db5/_c_p_u_features_8h.html',1,'']]],
+  ['create',['create',['../d2/dad/_hash_8h.html#a330b73d6927d6cd95892712f9396f40e',1,'MUtils::Hash']]]
 ];
diff --git a/docs/search/all_4.js b/docs/search/all_4.js
index 752aff4..f338b5b 100644
--- a/docs/search/all_4.js
+++ b/docs/search/all_4.js
@@ -1,4 +1,5 @@
 var searchData=
 [
-  ['detect',['detect',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a5f26f530b11eee62845fb45fba6a32fc',1,'MUtils::CPUFetaures']]]
+  ['detect',['detect',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a5f26f530b11eee62845fb45fba6a32fc',1,'MUtils::CPUFetaures']]],
+  ['digest',['digest',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a1d70f2b647935868a178920196ec0ac1',1,'MUtils::Hash::Hash']]]
 ];
diff --git a/docs/search/all_7.js b/docs/search/all_7.js
index 327b7eb..8abdf08 100644
--- a/docs/search/all_7.js
+++ b/docs/search/all_7.js
@@ -1,6 +1,10 @@
 var searchData=
 [
-  ['idstr',['idstr',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a58ab7955a771f842c3f16abd8cebb931',1,'MUtils::CPUFetaures::_cpu_info_t']]],
-  ['init_5fprocess',['init_process',['../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3',1,'MUtils']]],
-  ['ipcchannel',['IPCChannel',['../d5/dfe/class_m_utils_1_1_i_p_c_channel.html',1,'MUtils']]]
+  ['hash',['Hash',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html',1,'MUtils::Hash']]],
+  ['hash_2eh',['Hash.h',['../d2/dad/_hash_8h.html',1,'']]],
+  ['hash_5fblake2_5f512',['HASH_BLAKE2_512',['../d2/dad/_hash_8h.html#aa9e34ac422f4e52061cb8908f922fe17',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f224',['HASH_KECCAK_224',['../d2/dad/_hash_8h.html#a3cfb72f121ca5c03dd8452c322549d11',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f256',['HASH_KECCAK_256',['../d2/dad/_hash_8h.html#ae38cda07e425eb7c745492215a48ae08',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f384',['HASH_KECCAK_384',['../d2/dad/_hash_8h.html#af80dfb1569816fab7ab5ed32e6386458',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f512',['HASH_KECCAK_512',['../d2/dad/_hash_8h.html#a89ad922f2cada9a15893852d43134119',1,'MUtils::Hash']]]
 ];
diff --git a/docs/search/all_8.js b/docs/search/all_8.js
index e409b67..327b7eb 100644
--- a/docs/search/all_8.js
+++ b/docs/search/all_8.js
@@ -1,4 +1,6 @@
 var searchData=
 [
-  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html',1,'MUtils']]]
+  ['idstr',['idstr',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a58ab7955a771f842c3f16abd8cebb931',1,'MUtils::CPUFetaures::_cpu_info_t']]],
+  ['init_5fprocess',['init_process',['../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3',1,'MUtils']]],
+  ['ipcchannel',['IPCChannel',['../d5/dfe/class_m_utils_1_1_i_p_c_channel.html',1,'MUtils']]]
 ];
diff --git a/docs/search/all_9.js b/docs/search/all_9.js
index 78ae639..e409b67 100644
--- a/docs/search/all_9.js
+++ b/docs/search/all_9.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['keccak',['Keccak',['../dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html',1,'MUtils::Hash']]]
+  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html',1,'MUtils']]]
 ];
diff --git a/docs/search/all_a.js b/docs/search/all_a.js
index b91ff8b..0c14745 100644
--- a/docs/search/all_a.js
+++ b/docs/search/all_a.js
@@ -8,6 +8,7 @@ var searchData=
   ['mutils_5fbool2str',['MUTILS_BOOL2STR',['../d5/d3b/_global_8h.html#a177ecbfe7701c2ac04bb8bdeb208773a',1,'Global.h']]],
   ['mutils_5fdelete',['MUTILS_DELETE',['../d5/d3b/_global_8h.html#ad42b1946a83df3bd76734d5ab691fd0d',1,'Global.h']]],
   ['mutils_5fdelete_5farray',['MUTILS_DELETE_ARRAY',['../d5/d3b/_global_8h.html#aa544a37b80f1ab9d86f439a7666e9aa8',1,'Global.h']]],
+  ['mutils_5fno_5fcopy',['MUTILS_NO_COPY',['../d5/d3b/_global_8h.html#a8e7b4857b78f9749233e5abc96534ca8',1,'Global.h']]],
   ['mutils_5fqstr',['MUTILS_QSTR',['../d5/d3b/_global_8h.html#a04d63f6f60c90f8e3c4029824a7352b0',1,'Global.h']]],
   ['mutils_5futf8',['MUTILS_UTF8',['../d5/d3b/_global_8h.html#a88b0902153ea537b12d86267af20eb3f',1,'Global.h']]],
   ['mutils_5fwchr',['MUTILS_WCHR',['../d5/d3b/_global_8h.html#af55d43b39d3f41cf090c138ed190ee6e',1,'Global.h']]],
diff --git a/docs/search/all_e.js b/docs/search/all_e.js
index 50e2db7..f67e5ea 100644
--- a/docs/search/all_e.js
+++ b/docs/search/all_e.js
@@ -1,5 +1,4 @@
 var searchData=
 [
-  ['spongestatestruct',['spongeStateStruct',['../d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html',1,'MUtils::Hash::Internal::KeccakImpl']]],
   ['stepping',['stepping',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a1cfc86c6c61d35c7bd6f2a9cbecb99e4',1,'MUtils::CPUFetaures::_cpu_info_t']]]
 ];
diff --git a/docs/search/classes_1.js b/docs/search/classes_1.js
index d9ccfea..2e615db 100644
--- a/docs/search/classes_1.js
+++ b/docs/search/classes_1.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['blake2',['Blake2',['../d1/d01/class_m_utils_1_1_hash_1_1_blake2.html',1,'MUtils::Hash']]]
+  ['hash',['Hash',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html',1,'MUtils::Hash']]]
 ];
diff --git a/docs/search/classes_4.js b/docs/search/classes_4.js
index 78ae639..7bb19da 100644
--- a/docs/search/classes_4.js
+++ b/docs/search/classes_4.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['keccak',['Keccak',['../dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html',1,'MUtils::Hash']]]
+  ['registrykey',['RegistryKey',['../da/d35/class_m_utils_1_1_registry_1_1_registry_key.html',1,'MUtils::Registry']]]
 ];
diff --git a/docs/search/classes_5.js b/docs/search/classes_5.js
index 7bb19da..3150cd1 100644
--- a/docs/search/classes_5.js
+++ b/docs/search/classes_5.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['registrykey',['RegistryKey',['../da/d35/class_m_utils_1_1_registry_1_1_registry_key.html',1,'MUtils::Registry']]]
+  ['taskbar7',['Taskbar7',['../d2/d52/class_m_utils_1_1_taskbar7.html',1,'MUtils']]]
 ];
diff --git a/docs/search/classes_6.js b/docs/search/classes_6.js
index c5890a5..d8e4d05 100644
--- a/docs/search/classes_6.js
+++ b/docs/search/classes_6.js
@@ -1,4 +1,5 @@
 var searchData=
 [
-  ['spongestatestruct',['spongeStateStruct',['../d0/dd8/struct_m_utils_1_1_hash_1_1_internal_1_1_keccak_impl_1_1sponge_state_struct.html',1,'MUtils::Hash::Internal::KeccakImpl']]]
+  ['updatechecker',['UpdateChecker',['../d0/d8a/class_m_utils_1_1_update_checker.html',1,'MUtils']]],
+  ['updatecheckerinfo',['UpdateCheckerInfo',['../d1/d0d/class_m_utils_1_1_update_checker_info.html',1,'MUtils']]]
 ];
diff --git a/docs/search/classes_7.js b/docs/search/classes_7.js
index 3150cd1..367cd93 100644
--- a/docs/search/classes_7.js
+++ b/docs/search/classes_7.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['taskbar7',['Taskbar7',['../d2/d52/class_m_utils_1_1_taskbar7.html',1,'MUtils']]]
+  ['version',['Version',['../d1/d32/class_m_utils_1_1_version.html',1,'MUtils']]]
 ];
diff --git a/docs/search/classes_8.js b/docs/search/classes_8.js
deleted file mode 100644
index d8e4d05..0000000
--- a/docs/search/classes_8.js
+++ /dev/null
@@ -1,5 +0,0 @@
-var searchData=
-[
-  ['updatechecker',['UpdateChecker',['../d0/d8a/class_m_utils_1_1_update_checker.html',1,'MUtils']]],
-  ['updatecheckerinfo',['UpdateCheckerInfo',['../d1/d0d/class_m_utils_1_1_update_checker_info.html',1,'MUtils']]]
-];
diff --git a/docs/search/classes_9.js b/docs/search/classes_9.js
deleted file mode 100644
index 367cd93..0000000
--- a/docs/search/classes_9.js
+++ /dev/null
@@ -1,4 +0,0 @@
-var searchData=
-[
-  ['version',['Version',['../d1/d32/class_m_utils_1_1_version.html',1,'MUtils']]]
-];
diff --git a/docs/search/defines_0.js b/docs/search/defines_0.js
index 7eea83b..e724674 100644
--- a/docs/search/defines_0.js
+++ b/docs/search/defines_0.js
@@ -3,6 +3,7 @@ var searchData=
   ['mutils_5fbool2str',['MUTILS_BOOL2STR',['../d5/d3b/_global_8h.html#a177ecbfe7701c2ac04bb8bdeb208773a',1,'Global.h']]],
   ['mutils_5fdelete',['MUTILS_DELETE',['../d5/d3b/_global_8h.html#ad42b1946a83df3bd76734d5ab691fd0d',1,'Global.h']]],
   ['mutils_5fdelete_5farray',['MUTILS_DELETE_ARRAY',['../d5/d3b/_global_8h.html#aa544a37b80f1ab9d86f439a7666e9aa8',1,'Global.h']]],
+  ['mutils_5fno_5fcopy',['MUTILS_NO_COPY',['../d5/d3b/_global_8h.html#a8e7b4857b78f9749233e5abc96534ca8',1,'Global.h']]],
   ['mutils_5fqstr',['MUTILS_QSTR',['../d5/d3b/_global_8h.html#a04d63f6f60c90f8e3c4029824a7352b0',1,'Global.h']]],
   ['mutils_5futf8',['MUTILS_UTF8',['../d5/d3b/_global_8h.html#a88b0902153ea537b12d86267af20eb3f',1,'Global.h']]],
   ['mutils_5fwchr',['MUTILS_WCHR',['../d5/d3b/_global_8h.html#af55d43b39d3f41cf090c138ed190ee6e',1,'Global.h']]],
diff --git a/docs/search/classes_8.html b/docs/search/files_2.html
similarity index 94%
rename from docs/search/classes_8.html
rename to docs/search/files_2.html
index a57aeae..f5456fb 100644
--- a/docs/search/classes_8.html
+++ b/docs/search/files_2.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 
 
 
diff --git a/docs/search/files_2.js b/docs/search/files_2.js
new file mode 100644
index 0000000..a3d9c20
--- /dev/null
+++ b/docs/search/files_2.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['hash_2eh',['Hash.h',['../d2/dad/_hash_8h.html',1,'']]]
+];
diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js
index f8da9ee..625c19d 100644
--- a/docs/search/functions_1.js
+++ b/docs/search/functions_1.js
@@ -1,5 +1,6 @@
 var searchData=
 [
   ['clean_5ffile_5fname',['clean_file_name',['../d3/da6/namespace_m_utils.html#afd8eb699de88edd73e47fe2e41873385',1,'MUtils']]],
-  ['clean_5ffile_5fpath',['clean_file_path',['../d3/da6/namespace_m_utils.html#ad801fab93087c31d764ad15295fe3a88',1,'MUtils']]]
+  ['clean_5ffile_5fpath',['clean_file_path',['../d3/da6/namespace_m_utils.html#ad801fab93087c31d764ad15295fe3a88',1,'MUtils']]],
+  ['create',['create',['../d2/dad/_hash_8h.html#a330b73d6927d6cd95892712f9396f40e',1,'MUtils::Hash']]]
 ];
diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js
index 752aff4..f338b5b 100644
--- a/docs/search/functions_2.js
+++ b/docs/search/functions_2.js
@@ -1,4 +1,5 @@
 var searchData=
 [
-  ['detect',['detect',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a5f26f530b11eee62845fb45fba6a32fc',1,'MUtils::CPUFetaures']]]
+  ['detect',['detect',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a5f26f530b11eee62845fb45fba6a32fc',1,'MUtils::CPUFetaures']]],
+  ['digest',['digest',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a1d70f2b647935868a178920196ec0ac1',1,'MUtils::Hash::Hash']]]
 ];
diff --git a/docs/search/classes_9.html b/docs/search/functions_9.html
similarity index 93%
rename from docs/search/classes_9.html
rename to docs/search/functions_9.html
index 59ec044..6999e7e 100644
--- a/docs/search/classes_9.html
+++ b/docs/search/functions_9.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 
 
 
diff --git a/docs/search/functions_9.js b/docs/search/functions_9.js
new file mode 100644
index 0000000..f75715a
--- /dev/null
+++ b/docs/search/functions_9.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['update',['update',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a5c36bd2ea671928f9f5bd897dcfbef15',1,'MUtils::Hash::Hash::update(const quint8 *const data, const quint32 len)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a16bef08766de745913b3fd7c338bf5aa',1,'MUtils::Hash::Hash::update(const QByteArray &data)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#ace90c97585350dd246b6c655a3de571f',1,'MUtils::Hash::Hash::update(QFile &file)']]]
+];
diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js
index 9048c39..8bc0d42 100644
--- a/docs/search/searchdata.js
+++ b/docs/search/searchdata.js
@@ -1,11 +1,11 @@
 var indexSectionsWithContent =
 {
-  0: "_abcdfgijkmnprstuvx",
-  1: "_bijkrstuv",
+  0: "_abcdfghijmnprstuvx",
+  1: "_hijrtuv",
   2: "m",
-  3: "cg",
-  4: "acdimnprt",
-  5: "bcfimsvx",
+  3: "cgh",
+  4: "acdimnprtu",
+  5: "bcfhimsvx",
   6: "c",
   7: "m"
 };
diff --git a/docs/search/variables_3.js b/docs/search/variables_3.js
index 4e776bc..f647c5e 100644
--- a/docs/search/variables_3.js
+++ b/docs/search/variables_3.js
@@ -1,4 +1,8 @@
 var searchData=
 [
-  ['idstr',['idstr',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a58ab7955a771f842c3f16abd8cebb931',1,'MUtils::CPUFetaures::_cpu_info_t']]]
+  ['hash_5fblake2_5f512',['HASH_BLAKE2_512',['../d2/dad/_hash_8h.html#aa9e34ac422f4e52061cb8908f922fe17',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f224',['HASH_KECCAK_224',['../d2/dad/_hash_8h.html#a3cfb72f121ca5c03dd8452c322549d11',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f256',['HASH_KECCAK_256',['../d2/dad/_hash_8h.html#ae38cda07e425eb7c745492215a48ae08',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f384',['HASH_KECCAK_384',['../d2/dad/_hash_8h.html#af80dfb1569816fab7ab5ed32e6386458',1,'MUtils::Hash']]],
+  ['hash_5fkeccak_5f512',['HASH_KECCAK_512',['../d2/dad/_hash_8h.html#a89ad922f2cada9a15893852d43134119',1,'MUtils::Hash']]]
 ];
diff --git a/docs/search/variables_4.js b/docs/search/variables_4.js
index 04ad443..4e776bc 100644
--- a/docs/search/variables_4.js
+++ b/docs/search/variables_4.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['model',['model',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a7d0a012412dc4b04f2b5b37e83f5874a',1,'MUtils::CPUFetaures::_cpu_info_t']]]
+  ['idstr',['idstr',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a58ab7955a771f842c3f16abd8cebb931',1,'MUtils::CPUFetaures::_cpu_info_t']]]
 ];
diff --git a/docs/search/variables_5.js b/docs/search/variables_5.js
index f67e5ea..04ad443 100644
--- a/docs/search/variables_5.js
+++ b/docs/search/variables_5.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['stepping',['stepping',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a1cfc86c6c61d35c7bd6f2a9cbecb99e4',1,'MUtils::CPUFetaures::_cpu_info_t']]]
+  ['model',['model',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a7d0a012412dc4b04f2b5b37e83f5874a',1,'MUtils::CPUFetaures::_cpu_info_t']]]
 ];
diff --git a/docs/search/variables_6.js b/docs/search/variables_6.js
index 35f8c66..f67e5ea 100644
--- a/docs/search/variables_6.js
+++ b/docs/search/variables_6.js
@@ -1,6 +1,4 @@
 var searchData=
 [
-  ['vendor',['vendor',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a932a85bcdb1be4b191d8ecd61b87ad26',1,'MUtils::CPUFetaures::_cpu_info_t']]],
-  ['vendor_5famd',['VENDOR_AMD',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a37e26e9e81b42bd517928449fa28fc4e',1,'MUtils::CPUFetaures']]],
-  ['vendor_5fintel',['VENDOR_INTEL',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#af1d34d67451c27e125b507089bfd147f',1,'MUtils::CPUFetaures']]]
+  ['stepping',['stepping',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a1cfc86c6c61d35c7bd6f2a9cbecb99e4',1,'MUtils::CPUFetaures::_cpu_info_t']]]
 ];
diff --git a/docs/search/variables_7.js b/docs/search/variables_7.js
index 644654b..35f8c66 100644
--- a/docs/search/variables_7.js
+++ b/docs/search/variables_7.js
@@ -1,4 +1,6 @@
 var searchData=
 [
-  ['x64',['x64',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#aebb4aa6da8a1c381715a792f8904222f',1,'MUtils::CPUFetaures::_cpu_info_t']]]
+  ['vendor',['vendor',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a932a85bcdb1be4b191d8ecd61b87ad26',1,'MUtils::CPUFetaures::_cpu_info_t']]],
+  ['vendor_5famd',['VENDOR_AMD',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#a37e26e9e81b42bd517928449fa28fc4e',1,'MUtils::CPUFetaures']]],
+  ['vendor_5fintel',['VENDOR_INTEL',['../d3/d02/namespace_m_utils_1_1_c_p_u_fetaures.html#af1d34d67451c27e125b507089bfd147f',1,'MUtils::CPUFetaures']]]
 ];
diff --git a/docs/search/variables_8.html b/docs/search/variables_8.html
new file mode 100644
index 0000000..a74c6ca
--- /dev/null
+++ b/docs/search/variables_8.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
    
+
    Loading...
    
+
    
+
+
    Searching...
    
+
    No Matches
    
+
+
    
+
+
diff --git a/docs/search/variables_8.js b/docs/search/variables_8.js
new file mode 100644
index 0000000..644654b
--- /dev/null
+++ b/docs/search/variables_8.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['x64',['x64',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#aebb4aa6da8a1c381715a792f8904222f',1,'MUtils::CPUFetaures::_cpu_info_t']]]
+];
diff --git a/include/MUtils/Global.h b/include/MUtils/Global.h
index 687db49..fca4d3c 100644
--- a/include/MUtils/Global.h
+++ b/include/MUtils/Global.h
@@ -356,3 +356,9 @@ namespace MUtils
 /** \brief Converts a boolean expression into a string. A *true* boolean expression is converted to the string `"1"`; a *false* boolean expression is converted to the string `"0"`.
 */
 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")
+
+/** \brief Disables copy constructor and assignment operator in the specified class. This macro should be used in the "private" section of the class' declaration.
+*/
+#define MUTILS_NO_COPY(CLASS) \
+	CLASS(const CLASS &) { throw "Copy constructor is disabled!"; } \
+	CLASS &operator=(const CLASS &) { throw "Assignment operator is disabled!"; }
diff --git a/include/MUtils/Hash.h b/include/MUtils/Hash.h
index e8336b5..dac0cba 100644
--- a/include/MUtils/Hash.h
+++ b/include/MUtils/Hash.h
@@ -19,6 +19,13 @@
 // http://www.gnu.org/licenses/lgpl-2.1.txt
 //////////////////////////////////////////////////////////////////////////////////
 
+/**
+* @file
+* @brief This file contains function for cryptographic hash computation
+*
+* Call the MUtils::Hash::create() function to create an instance of the desired hash function. All Hash functions implement the MUtils::Hash::Hash interface.
+*/
+
 #pragma once
 
 //MUtils
@@ -32,21 +39,70 @@ namespace MUtils
 {
 	namespace Hash
 	{
-		static const quint16 HASH_BLAKE2_512 = 0x0000U;
-		static const quint16 HASH_KECCAK_224 = 0x0100U;
-		static const quint16 HASH_KECCAK_256 = 0x0101U;
-		static const quint16 HASH_KECCAK_384 = 0x0102U;
-		static const quint16 HASH_KECCAK_512 = 0x0103U;
+		static const quint16 HASH_BLAKE2_512 = 0x0000U;	///< \brief Hash algorithm identifier \details Use [BLAKE2](https://blake2.net/) hash algorithm, with a length of 512-Bit.
+		static const quint16 HASH_KECCAK_224 = 0x0100U;	///< \brief Hash algorithm identifier \details Use [Keccak](http://keccak.noekeon.org/) (SHA-3) hash algorithm, with a length of 224-Bit.
+		static const quint16 HASH_KECCAK_256 = 0x0101U;	///< \brief Hash algorithm identifier \details Use [Keccak](http://keccak.noekeon.org/) (SHA-3) hash algorithm, with a length of 256-Bit.
+		static const quint16 HASH_KECCAK_384 = 0x0102U;	///< \brief Hash algorithm identifier \details Use [Keccak](http://keccak.noekeon.org/) (SHA-3) hash algorithm, with a length of 384-Bit.
+		static const quint16 HASH_KECCAK_512 = 0x0103U;	///< \brief Hash algorithm identifier \details Use [Keccak](http://keccak.noekeon.org/) (SHA-3) hash algorithm, with a length of 512-Bit.
 
+		/**
+		* \brief This abstract class specifies the generic interface for all support hash algorithms.
+		*
+		* In order to compute a hash value (digest) call the the Hash::update() function repeatedly until all input data (i.e. the complete "message") has been processed. Then call the Hash::digest() function to retrieve the final hash value.
+		*
+		* All overloads of the Hash::update() function may be called in an interleaved fashion as needed.
+		*
+		* This class is **not** thread-safe, i.e. do **not** call the *same* Hash instance from difference threads, unless serialization is ensured (e.g. by means of a Mutex). It is safe, however, to call different *different* Hash instances from difference threads concurrently.
+		*/
 		class MUTILS_API Hash
 		{
 		public:
 			virtual ~Hash(void) {};
 
+			/**
+			* \brief Process the next chunk of input data
+			*
+			* Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.
+			*
+			* \param data A read-only pointer to the memory buffer holding the input data to be processed.
+			*
+			* \param len The length of the input data, in bytes. The `data` parameter must be pointing to a memory buffer that is at least `len` bytes in size.
+			*
+			* \return The function returns `true`, if the input data was processed successfully; otherwise it returns `false`.
+			*/
 			bool update(const quint8 *const data, const quint32 len) { return process(data, len); }
+
+			/**
+			* \brief Process the next chunk of input data
+			*
+			* Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.
+			*
+			* \param data A read-only reference to a QByteArray object holding the input data to be processed. All bytes in the QByteArray object will be processed.
+			*
+			* \return The function returns `true`, if the input data was processed successfully; otherwise it returns `false`.
+			*/
 			bool update(const QByteArray &data) { return process(((const quint8*)data.constData()), ((quint32)data.length())); }
+
+			/**
+			* \brief Process the next chunk of input data
+			*
+			* Updates the internal state of the hash function by processing the next chunk of input that. Can be called repeatedly, until until all input data has been processed.
+			*
+			* \param data A reference to a QFile object. The QFile object must be open and readable. All data from the current file position to the end of the file will be processed.
+			*
+			* \return The function returns `true`, if all data in the file was processed successfully; otherwise (e.g. in case of file read errors) it returns `false`.
+			*/
 			bool update(QFile &file);
 
+			/**
+			* \brief Retrieve the hash value
+			*
+			* This function is used to retrieve the final hash value (digest), after all input data has been processed successfully.
+			*
+			* \param bAsHex If set to `true`, the function returns the hash value as a Hexadecimal-encoded ASCII string; if set to `false`, the function returns the hash value as "raw" bytes.
+			*
+			* \return The function returns a QByteArray object holding the final hash value (digest). The format depends on the `bAsHex` parameter.
+			*/
 			QByteArray digest(const bool bAsHex = true) { return bAsHex ? finalize().toHex() : finalize(); }
 
 		protected:
@@ -55,10 +111,20 @@ namespace MUtils
 			virtual QByteArray finalize(void) = 0;
 
 		private:
-			Hash &operator=(const Hash&) { throw "Disabled"; }
-			Hash(const Hash&)            { throw "Disabled"; }
+			MUTILS_NO_COPY(Hash);
 		};
 
+		/**
+		* \brief Create instance of a hash function
+		*
+		* This function is used to create a new instance of the desired hash function. All Hash functions implement the MUtils::Hash::Hash interface. The caller is responsible for destroying the returned MUtils::Hash::Hash object.
+		*
+		* \param hashId Specifies the desired hash function. This must be a valid hash algorithm identifier, as defined in the `Hash.h` header file.
+		*
+		* \param key Specifies on optional key that is used to "seed" the hash function. If a key is given, it must be a NULL-terminated string of appropriate length. If set to `NULL`, the optional seeding is skipped.
+
+		* \return Returns a pointer to a new MUtils::Hash::Hash object that implements the desired hash function. The function throws if an invalid algorithm identifier was specified!
+		*/
 		MUTILS_API Hash *create(const quint16 &hashId, const char *const key = NULL);
 	}
 }
diff --git a/include/MUtilsInfo.dox b/include/MUtilsInfo.dox
index 069e190..aecb6b4 100644
--- a/include/MUtilsInfo.dox
+++ b/include/MUtilsInfo.dox
@@ -11,6 +11,7 @@
  * The public API of the *MUtilities* library is defined in the following header files (select file for details):
  * - **Global.h** – miscellaneous useful functions
  * - **CPUFeatures.h** – functions for detection information about the CPU
+ * - **Hash.h** – functions for cryptographic hash computation
  * 
  * 
  * # Example
-- 
2.11.0