From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

VKON / TVision-0.22 / tvision.git / include / tvision / helpbase.h 

            

              
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

              
/* ------------------------------------------------------------------------*/
/*                                                                         */
/*   HELPBASE.H                                                            */
/*                                                                         */
/*   defines the classes TParagraph, TCrossRef, THelpTopic, THelpIndex,    */
/*      THelpFile                                                          */
/*                                                                         */
/* ------------------------------------------------------------------------*/
/*
 *      Turbo Vision - Version 2.0
 *
 *      Copyright (c) 1994 by Borland International
 *      All Rights Reserved.
 *
 */
#if !defined( __HELPBASE_H )
#define __HELPBASE_H
const int32_t magicHeader = 0x46484246L; //"FBHF"
#define cHelpViewer "\x06\x07\x08"
#define cHelpWindow "\x80\x81\x82\x83\x84\x85\x86\x87"
// TParagraph
class TParagraph
{
public:
    TParagraph() noexcept {}
    TParagraph *next;
    Boolean wrap;
    ushort size;
    char *text;
};
// TCrossRef
class TCrossRef
{
public:
    TCrossRef() noexcept {}
    int ref;
    int offset;
    uchar length;
};
typedef void (*TCrossRefHandler) ( opstream&, int );
class THelpTopic: public TObject, public TStreamable
{
public:
    THelpTopic() noexcept;
    THelpTopic( StreamableInit ) noexcept {};
    virtual ~THelpTopic();
    void addCrossRef( TCrossRef ref ) noexcept;
    void addParagraph( TParagraph *p ) noexcept;
    void getCrossRef( int i, TPoint& loc, uchar& length, int& ref ) noexcept;
    TStringView getLine( int line ) noexcept;
    int getNumCrossRefs() noexcept;
    int numLines() noexcept;
    void setCrossRef( int i, TCrossRef& ref ) noexcept;
    void setNumCrossRefs( int i ) noexcept;
    void setWidth( int aWidth ) noexcept;
    TParagraph *paragraphs;
    int numRefs;
    TCrossRef *crossRefs;
private:
    TStringView wrapText( char *text, int size, int& offset, Boolean wrap ) noexcept;
    void readParagraphs( ipstream& s );
    void readCrossRefs( ipstream& s );
    void writeParagraphs( opstream& s );
    void writeCrossRefs( opstream& s );
    void disposeParagraphs() noexcept;
    virtual const char *streamableName() const
        { return name; }
    int width;
    int lastOffset;
    int lastLine;
    TParagraph *lastParagraph;
protected:
    virtual void write( opstream& );
    virtual void *read( ipstream& );
public:
    static const char * const _NEAR name;
    static TStreamable *build();
};
inline ipstream& operator >> ( ipstream& is, THelpTopic& cl )
    { return is >> (TStreamable&)cl; }
inline ipstream& operator >> ( ipstream& is, THelpTopic*& cl )
    { return is >> (void *&)cl; }
inline opstream& operator << ( opstream& os, THelpTopic& cl )
    { return os << (TStreamable&)cl; }
inline opstream& operator << ( opstream& os, THelpTopic* cl )
    { return os << (TStreamable *)cl; }
// THelpIndex
class THelpIndex : public TObject, public TStreamable
{
public:
    THelpIndex() noexcept;
    THelpIndex( StreamableInit ) noexcept {};
    virtual ~THelpIndex();
    int32_t position( int ) noexcept;
    void add( int, int32_t );
    ushort size;
    int32_t *index;
private:
    virtual const char *streamableName() const
        { return name; }
protected:
    virtual void write( opstream& );
    virtual void *read( ipstream& );
public:
    static const char * const _NEAR name;
    static TStreamable *build();
};
inline ipstream& operator >> ( ipstream& is, THelpIndex& cl )
    { return is >> (TStreamable&)cl; }
inline ipstream& operator >> ( ipstream& is, THelpIndex*& cl )
    { return is >> (void *&)cl; }
inline opstream& operator << ( opstream& os, THelpIndex& cl )
    { return os << (TStreamable&)cl; }
inline opstream& operator << ( opstream& os, THelpIndex* cl )
    { return os << (TStreamable *)cl; }
// THelpFile
class THelpFile : public TObject
{
    static const char * _NEAR invalidContext;
public:
    THelpFile( iopstream& s );
    virtual ~THelpFile();
    THelpTopic *getTopic( int );
    THelpTopic *invalidTopic();
    void recordPositionInIndex( int );
    void putTopic( THelpTopic* );
    iopstream *stream;
    Boolean modified;
    THelpIndex *index;
    int32_t indexPos;
};
extern void notAssigned( opstream& s, int value );
extern TCrossRefHandler crossRefHandler;
#endif  // __HELPBASE_H