tedit/RStrArray.hpp at master · mduffor/tedit · GitHub

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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/* -----------------------------------------------------------------
                            TEdit String Array

    This module implements a string array class.

                            Michael T. Duffy
   ----------------------------------------------------------------- */

// RStrArray.hpp
// Copyright 2004, 2008, Michael T. Duffy.
// contact:  mduffor@gmail.com

// This file is part of TEdit.
//
// TEdit is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 3 as
// published by the Free Software Foundation.
//
// TEdit is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with TEdit.  If not, see <http://www.gnu.org/licenses/>.


#ifndef RSTRARRAY_HPP
#define RSTRARRAY_HPP

#include <ctype.h>
#include <stdarg.h>   // for variable argument functions (va_*)
#include "Types.hpp"
#include "BaseArray.hpp"
#include "IntArray.hpp"
#include "RStr.hpp"


/// An array of RStr instances
//-----------------------------------------------------------------------------
class RStrArray : public BaseArray
  {
  private:

  public:

                 RStrArray      ();
                 RStrArray      (const RStrArray &  arrayIn);
                 RStrArray      (INT   iInitialSize);
                 ~RStrArray     ();

    VOID *       AllocArray     (INT      iSizeIn);
    VOID         DeleteArray    (PVOID *  pvArrayIn);
    VOID         InitValues     (INT      iStartOffset,
                                 INT      iNumToInit);
    VOID         CopyValues     (PVOID    pvSourceData,
                                 INT      iSourceOffsetIn,
                                 INT      iStartOffset,
                                 INT      iNumToCopy);
    VOID         CopyValuesRev  (PVOID    pvSourceData,
                                 INT      iSourceOffsetIn,
                                 INT      iStartOffset,
                                 INT      iNumToCopy);
    VOID         AverageValues  (INT      iIndexAverage,
                                 INT      iIndexValueOne,
                                 INT      iIndexValueTwo,
                                 FLOAT    fBias = 0.5f);
    VOID         SwapIndexes    (INT  iIndexOne,
                                 INT  iIndexTwo);
    INT          CompareIndexes (INT  iIndexOne,
                                 INT  iIndexTwo);

    EStatus      Copy           (const RStrArray &  arraySource);
    EStatus      Set            (RStr  strElement, INT  iIndex);
    EStatus      Append         (RStr  strElement);
    EStatus      GetArray       (RStr  []) const;

    RStr         Index          (INT  iIndex) const  {return ((*this)[iIndex]);};
    RStr         operator[]     (INT  iIndex) const;
    RStr &       operator[]     (INT  iIndex);
    RStrArray &  operator=      (const  RStrArray & arrayIn);
    BOOL         operator==     (const  RStrArray & arrayIn);
    BOOL         operator!=     (const  RStrArray & arrayIn)   {return (!(*this == arrayIn));};

                                /**
                                @brief Insert another array into this array at a given position
                                @param iIndexIn Position where the new array should be inserted
                                @param arrayToInsertIn The array that you want to insert.
                                @return None
                                */
    EStatus      Insert         (INT          iIndexIn,
                                 RStrArray &  arrayToInsertIn);

    INT          Find           (RStr &  strIn);

    INT          Find           (const char *  pszIn);

    VOID         SortIndexes    (IntArray &  arrayOut);

  };


#endif // RSTRARRAY_HPP