summaryrefslogtreecommitdiff
path: root/l10ntools/inc/wtratree.hxx
blob: 6fd33a7cb413bb92e294c7e21d295584f06784fc (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/


#ifndef TX3_WTRATREE_HXX
#define TX3_WTRATREE_HXX

// USED
    // Base Classes
    // Components
    // Parameters
#include <tools/string.hxx>

const INT16     C_NR_OF_WTT_RESULTS = 5;
const INT16     C_NR_OF_POSSIBLE_CHARS = 256;


typedef unsigned char u_char;
typedef const char * constr;


class WTT_Node;


/** @task
    This class implements the functionality, that class WordTransformer
    offers.
    WordTransformer is dependant of this class, but NOT the other way!
**/
class WordTransTree
{
  public:
    enum E_Result
    {
        OK = 0,
        HOTKEY_LOST,
        OUTPUT_OVERFLOW
    };


    //  LIFECYCLE
                        WordTransTree(
                            CharSet             i_nWorkingCharSet = RTL_TEXTENCODING_MS_1252);
    void                SetCharSet(
                            CharSet             i_nWorkingCharSet);
                        ~WordTransTree();

    void                AddWordPair(
                            const ByteString &      i_sOldString,
                            const ByteString &      i_sReplaceString );

    // OPERATIONS
    void                InitTransformation(
                            const char *        i_sInput,               /// [!=0], a range of i_nInputLength must be valid memory for read.
                            UINT32              i_nInputLength,
                            UINT32              i_nOutputMaxLength = STRING_MAXLEN - 12 );
    E_Result            TransformNextToken();

    // INQUIRY
    BOOL                TextEndReached() const;
    const char *        Output() const;

        // These 3 functions are valid between two calls of
        //   TransformNextToken():
    E_Result            CurResult() const;
    ByteString          CurReplacedString() const;
    ByteString          CurReplacingString() const;
    char                CurHotkey() const;

  private:
    // SERVICE FUNCTONS
    UINT8               CalculateBranch(
                            u_char              i_cInputChar ) const;

    void                Handle_Hotkey();
    void                Handle_TokenToKeep();
    void                Handle_TokenToTransform();

    // DATA
        // Fixed data
    const u_char *      sInput;
    UINT32              nInputLength;
    const u_char *      pInputEnd;

    u_char *            sOutput;                // DYN
    UINT32              nOutputMaxLength;

    WTT_Node *          dpParsingTreeTop;       // DYN
    WTT_Node *          pUnknownAlpha;
    u_char              cChar2Branch[C_NR_OF_POSSIBLE_CHARS];
    u_char              c_AE, c_OE, c_UE, c_ae, c_oe, c_ue;

        // Working data
    const u_char *      pInputCurTokenStart;
    const u_char *      pInputPosition;
    u_char *            pOutputPosition;
    WTT_Node *          pCurParseNode;

        // Data which are valid only after a completed call to TransformNextToken()
    E_Result            eCurResult;
    u_char              cCurHotkey;             // Letter wich is used as hotkey
    u_char              cCurHotkeySign;         // Letter which is used to assign hotkey ('~'or '&') .
};







inline BOOL
WordTransTree::TextEndReached() const
    { return pInputPosition == pInputEnd; }
inline const char *
WordTransTree::Output() const
    { return TextEndReached() ? (constr) sOutput : ""; }
inline WordTransTree::E_Result
WordTransTree::CurResult() const
    { return eCurResult; }
inline ByteString
WordTransTree::CurReplacedString() const
    { return ByteString((constr) pInputCurTokenStart,pInputPosition-pInputCurTokenStart); }
inline char
WordTransTree::CurHotkey() const
    { return cCurHotkey; }
inline UINT8
WordTransTree::CalculateBranch(u_char i_cInputChar) const
    { return cChar2Branch[i_cInputChar]; }



#endif