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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/* Copyright 2020 Jaakko Keränen <jaakko.keranen@iki.fi>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
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. */
#pragma once
#include "defs.h"
#include "gmutil.h"
#include "media.h"
#include <the_Foundation/array.h>
#include <the_Foundation/object.h>
#include <the_Foundation/rect.h>
#include <the_Foundation/string.h>
#include <the_Foundation/time.h>
iDeclareType(GmHeading)
iDeclareType(GmPreMeta)
iDeclareType(GmRun)
enum iGmLineType {
text_GmLineType,
bullet_GmLineType,
preformatted_GmLineType,
quote_GmLineType,
heading1_GmLineType,
heading2_GmLineType,
heading3_GmLineType,
link_GmLineType,
max_GmLineType,
};
enum iGmLineType lineType_Rangecc (const iRangecc line);
void trimLine_Rangecc (iRangecc *line, enum iGmLineType type, iBool normalize);
enum iGmDocumentTheme {
colorfulDark_GmDocumentTheme,
colorfulLight_GmDocumentTheme,
black_GmDocumentTheme,
gray_GmDocumentTheme,
white_GmDocumentTheme,
sepia_GmDocumentTheme,
highContrast_GmDocumentTheme,
max_GmDocumentTheme
};
iBool isDark_GmDocumentTheme(enum iGmDocumentTheme);
typedef uint16_t iGmLinkId;
enum iGmLinkScheme {
gemini_GmLinkScheme = 1,
titan_GmLinkScheme,
gopher_GmLinkScheme,
finger_GmLinkScheme,
http_GmLinkScheme,
file_GmLinkScheme,
data_GmLinkScheme,
about_GmLinkScheme,
mailto_GmLinkScheme,
};
enum iGmLinkFlag {
supportedScheme_GmLinkFlag = 0x3f, /* mask of bits 1...6 */
remote_GmLinkFlag = iBit(7),
humanReadable_GmLinkFlag = iBit(8), /* link has a human-readable description */
imageFileExtension_GmLinkFlag = iBit(9),
audioFileExtension_GmLinkFlag = iBit(10),
content_GmLinkFlag = iBit(11), /* content visible below */
visited_GmLinkFlag = iBit(12), /* in the history */
permanent_GmLinkFlag = iBit(13), /* content cannot be dismissed; media link */
query_GmLinkFlag = iBit(14), /* Gopher query link */
iconFromLabel_GmLinkFlag = iBit(15), /* use an Emoji/special character from label */
isOpen_GmLinkFlag = iBit(16), /* currently open in a tab */
};
iLocalDef enum iGmLinkScheme scheme_GmLinkFlag(int flags) {
return flags & supportedScheme_GmLinkFlag;
}
struct Impl_GmHeading {
iRangecc text;
int level; /* 0, 1, 2 */
};
enum iGmPreMetaFlag {
folded_GmPreMetaFlag = 0x1,
topLeft_GmPreMetaFlag = 0x2,
};
struct Impl_GmPreMeta {
iRangecc bounds; /* including ``` markers */
iRangecc altText; /* range in source */
iRangecc contents; /* just the content lines */
int flags;
/* TODO: refactor old code to incorporate wide scroll handling here */
iRect pixelRect;
};
enum iGmRunFlags {
decoration_GmRunFlag = iBit(1), /* not part of the source */
startOfLine_GmRunFlag = iBit(2),
endOfLine_GmRunFlag = iBit(3),
siteBanner_GmRunFlag = iBit(4), /* area reserved for the site banner */
quoteBorder_GmRunFlag = iBit(5),
wide_GmRunFlag = iBit(6), /* horizontally scrollable */
footer_GmRunFlag = iBit(7),
altText_GmRunFlag = iBit(8),
};
enum iGmRunMediaType {
none_GmRunMediaType,
image_GmRunMediaType,
audio_GmRunMediaType,
download_GmRunMediaType,
};
struct Impl_GmRun {
iRangecc text;
iRect bounds; /* used for hit testing, may extend to edges */
iRect visBounds; /* actual visual bounds */
struct {
uint16_t color : 8;
uint16_t font : 7;
uint16_t isRTL : 1;
} textParams;
uint8_t flags;
uint8_t mediaType;
uint16_t preId; /* preformatted block ID (sequential) */
iGmLinkId linkId; /* zero for non-links */
uint16_t mediaId; /* zero if not an image */
};
iDeclareType(GmRunRange)
struct Impl_GmRunRange {
const iGmRun *start;
const iGmRun *end;
};
iRangecc findLoc_GmRun (const iGmRun *, iInt2 pos);
iDeclareClass(GmDocument)
iDeclareObjectConstruction(GmDocument)
enum iGmDocumentBanner {
none_GmDocumentBanner,
siteDomain_GmDocumentBanner,
certificateWarning_GmDocumentBanner,
};
enum iGmDocumentUpdate {
partial_GmDocumentUpdate, /* appending more content */
final_GmDocumentUpdate, /* process all lines, including the last one if not terminated */
};
void setThemeSeed_GmDocument (iGmDocument *, const iBlock *seed);
void setFormat_GmDocument (iGmDocument *, enum iSourceFormat format);
void setBanner_GmDocument (iGmDocument *, enum iGmDocumentBanner type);
void setWidth_GmDocument (iGmDocument *, int width, int outsideMargin);
void redoLayout_GmDocument (iGmDocument *);
iBool updateOpenURLs_GmDocument(iGmDocument *);
void setUrl_GmDocument (iGmDocument *, const iString *url);
void setSource_GmDocument (iGmDocument *, const iString *source, int width, int outsideMargin,
enum iGmDocumentUpdate updateType);
void foldPre_GmDocument (iGmDocument *, uint16_t preId);
void updateVisitedLinks_GmDocument (iGmDocument *); /* check all links for visited status */
void invalidatePalette_GmDocument (iGmDocument *);
void makePaletteGlobal_GmDocument (const iGmDocument *); /* copies document colors to the global palette */
//void reset_GmDocument (iGmDocument *); /* free images */
typedef void (*iGmDocumentRenderFunc)(void *, const iGmRun *);
iMedia * media_GmDocument (iGmDocument *);
const iMedia * constMedia_GmDocument (const iGmDocument *);
const iString * url_GmDocument (const iGmDocument *);
void render_GmDocument (const iGmDocument *, iRangei visRangeY,
iGmDocumentRenderFunc render, void *); /* includes partial overlaps */
const iGmRun * renderProgressive_GmDocument(const iGmDocument *d, const iGmRun *first, int dir,
size_t maxCount,
iRangei visRangeY, iGmDocumentRenderFunc render,
void *context);
iInt2 size_GmDocument (const iGmDocument *);
const iGmRun * siteBanner_GmDocument (const iGmDocument *);
iBool hasSiteBanner_GmDocument (const iGmDocument *);
enum iGmDocumentBanner bannerType_GmDocument(const iGmDocument *);
const iString * bannerText_GmDocument (const iGmDocument *);
const iArray * headings_GmDocument (const iGmDocument *); /* array of GmHeadings */
const iString * source_GmDocument (const iGmDocument *);
size_t memorySize_GmDocument (const iGmDocument *); /* bytes */
iRangecc findText_GmDocument (const iGmDocument *, const iString *text, const char *start);
iRangecc findTextBefore_GmDocument (const iGmDocument *, const iString *text, const char *before);
iGmRunRange findPreformattedRange_GmDocument (const iGmDocument *, const iGmRun *run);
enum iGmLinkPart {
icon_GmLinkPart,
text_GmLinkPart,
textHover_GmLinkPart,
domain_GmLinkPart,
visited_GmLinkPart,
};
const iGmRun * findRun_GmDocument (const iGmDocument *, iInt2 pos);
iRangecc findLoc_GmDocument (const iGmDocument *, iInt2 pos);
const iGmRun * findRunAtLoc_GmDocument (const iGmDocument *, const char *loc);
const iString * linkUrl_GmDocument (const iGmDocument *, iGmLinkId linkId);
iRangecc linkUrlRange_GmDocument (const iGmDocument *, iGmLinkId linkId);
iRangecc linkLabel_GmDocument (const iGmDocument *, iGmLinkId linkId);
iMediaId linkImage_GmDocument (const iGmDocument *, iGmLinkId linkId);
iMediaId linkAudio_GmDocument (const iGmDocument *, iGmLinkId linkId);
int linkFlags_GmDocument (const iGmDocument *, iGmLinkId linkId);
enum iColorId linkColor_GmDocument (const iGmDocument *, iGmLinkId linkId, enum iGmLinkPart part);
const iTime * linkTime_GmDocument (const iGmDocument *, iGmLinkId linkId);
iBool isMediaLink_GmDocument (const iGmDocument *, iGmLinkId linkId);
const iString * title_GmDocument (const iGmDocument *);
iChar siteIcon_GmDocument (const iGmDocument *);
const iGmPreMeta *preMeta_GmDocument (const iGmDocument *, uint16_t preId);
iInt2 preRunMargin_GmDocument (const iGmDocument *, uint16_t preId);
iBool preIsFolded_GmDocument (const iGmDocument *, uint16_t preId);
iBool preHasAltText_GmDocument(const iGmDocument *, uint16_t preId);
|
