summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4Comparable.h
blob: 36f5335181a93cd0db0551324e1df85971500afa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: Dk4Comparable.cpt
*/

/*
Copyright (C) 2013-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**	@file Dk4Comparable.h Header file for the Dk4Comparable module.
*/

#ifndef DK4COMPARABLE_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4COMPARABLE_H_INCLUDED 1


#line 8 "Dk4Comparable.cpt"

namespace DkTools4 {

  /**	Comparable is a general base class for the library.
  */
  class Comparable
  {
    public:
      /**	Compare object against another object or some data.
	  This comparison is used by sorted containers.
	  Example: When storing persons (name and age) we can use
	  crit=0 as comparison criteria in the container to compare
	  person object against person object. When searching the container
	  for an object with a specific name we can use crit=1 for comparisons
	  of the object against a string.
    	  @param	ptr	Address of other object or data.
	  @param	crit	Comparison criteria, see documentation of
	  derived classes for class-specific numbers.
	  @return	Positive number if larger than ptr, 0 if evaluates
	  equal to ptr, negative number if smaller than ptr.
      */
      virtual
      int
      compareAgainst(void const *ptr, int crit) const = 0;

      /**	Compare two pointers
      		@param	l	Left pointer.
		@param	r	Right pointer.
		@param	cr	Comparison criteria.
		@return	1 for left object is large, 0 for right object
		is large, 0 for objects evaluating equally.
      */
      static
      int
      compareTwoPointers(void const *l, void const *r, int cr);

  };	/* End of class Comparable. */

}	/* End of namespace DkTools4 */



#endif