Blame


1 5e11c00c 2021-03-02 op /*
2 5e11c00c 2021-03-02 op * Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 5e11c00c 2021-03-02 op *
4 5e11c00c 2021-03-02 op * Permission to use, copy, modify, and distribute this software for any
5 5e11c00c 2021-03-02 op * purpose with or without fee is hereby granted, provided that the above
6 5e11c00c 2021-03-02 op * copyright notice and this permission notice appear in all copies.
7 5e11c00c 2021-03-02 op *
8 5e11c00c 2021-03-02 op * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 5e11c00c 2021-03-02 op * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 5e11c00c 2021-03-02 op * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 5e11c00c 2021-03-02 op * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 5e11c00c 2021-03-02 op * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 5e11c00c 2021-03-02 op * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 5e11c00c 2021-03-02 op * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 5e11c00c 2021-03-02 op */
16 5e11c00c 2021-03-02 op
17 5e11c00c 2021-03-02 op #ifndef TELESCOPE_H
18 5e11c00c 2021-03-02 op #define TELESCOPE_H
19 5e11c00c 2021-03-02 op
20 b0003f58 2021-03-08 op #include "compat.h"
21 5e11c00c 2021-03-02 op
22 65d9b3ca 2021-03-14 op #include <event.h>
23 65d9b3ca 2021-03-14 op
24 b0003f58 2021-03-08 op #include "url.h"
25 5e11c00c 2021-03-02 op
26 dc5df781 2021-03-13 op #define MIN(a, b) ((a) < (b) ? (a) : (b))
27 dc5df781 2021-03-13 op #define MAX(a, b) ((a) > (b) ? (a) : (b))
28 dc5df781 2021-03-13 op
29 5e11c00c 2021-03-02 op #define GEMINI_URL_LEN 1024
30 5e11c00c 2021-03-02 op
31 5e11c00c 2021-03-02 op enum imsg_type {
32 740f578b 2021-03-15 op /* ui <-> client/fs */
33 5e11c00c 2021-03-02 op IMSG_GET, /* data is URL, peerid the tab id */
34 5e11c00c 2021-03-02 op IMSG_ERR,
35 5e11c00c 2021-03-02 op IMSG_CHECK_CERT,
36 5e11c00c 2021-03-02 op IMSG_CERT_STATUS,
37 5e11c00c 2021-03-02 op IMSG_GOT_CODE,
38 5e11c00c 2021-03-02 op IMSG_GOT_META,
39 0972d8b2 2021-03-02 op IMSG_PROCEED,
40 0972d8b2 2021-03-02 op IMSG_STOP,
41 5e11c00c 2021-03-02 op IMSG_BUF,
42 5e11c00c 2021-03-02 op IMSG_EOF,
43 5e11c00c 2021-03-02 op IMSG_QUIT,
44 740f578b 2021-03-15 op
45 740f578b 2021-03-15 op /* ui <-> fs */
46 740f578b 2021-03-15 op IMSG_BOOKMARK_PAGE,
47 740f578b 2021-03-15 op IMSG_BOOKMARK_OK,
48 3a227e9a 2021-03-18 op IMSG_SAVE_CERT,
49 3a227e9a 2021-03-18 op IMSG_SAVE_CERT_OK,
50 5e11c00c 2021-03-02 op };
51 5e11c00c 2021-03-02 op
52 5e11c00c 2021-03-02 op enum line_type {
53 5e11c00c 2021-03-02 op LINE_TEXT,
54 5e11c00c 2021-03-02 op LINE_LINK,
55 5e11c00c 2021-03-02 op LINE_TITLE_1,
56 5e11c00c 2021-03-02 op LINE_TITLE_2,
57 5e11c00c 2021-03-02 op LINE_TITLE_3,
58 5e11c00c 2021-03-02 op LINE_ITEM,
59 5e11c00c 2021-03-02 op LINE_QUOTE,
60 5e11c00c 2021-03-02 op LINE_PRE_START,
61 5e11c00c 2021-03-02 op LINE_PRE_CONTENT,
62 5e11c00c 2021-03-02 op LINE_PRE_END,
63 5e11c00c 2021-03-02 op };
64 5e11c00c 2021-03-02 op
65 5e11c00c 2021-03-02 op struct line {
66 5e11c00c 2021-03-02 op enum line_type type;
67 5e11c00c 2021-03-02 op char *line;
68 5e11c00c 2021-03-02 op char *alt;
69 ebdcadbf 2021-03-12 op int flags;
70 5e11c00c 2021-03-02 op TAILQ_ENTRY(line) lines;
71 5e11c00c 2021-03-02 op };
72 5e11c00c 2021-03-02 op
73 9a25f829 2021-03-14 op struct vline {
74 9a25f829 2021-03-14 op const struct line *parent;
75 9a25f829 2021-03-14 op char *line;
76 9a25f829 2021-03-14 op int flags;
77 9a25f829 2021-03-14 op TAILQ_ENTRY(vline) vlines;
78 9a25f829 2021-03-14 op };
79 9a25f829 2021-03-14 op
80 5e11c00c 2021-03-02 op struct parser;
81 5e11c00c 2021-03-02 op struct page;
82 5e11c00c 2021-03-02 op
83 5e11c00c 2021-03-02 op /* typedef void (*initparserfn)(struct parser*); */
84 5e11c00c 2021-03-02 op
85 5e11c00c 2021-03-02 op typedef int (*parsechunkfn)(struct parser*, const char*, size_t);
86 a5c3e03d 2021-03-02 op typedef int (*parserfreefn)(struct parser*);
87 5e11c00c 2021-03-02 op
88 5e11c00c 2021-03-02 op typedef void (imsg_handlerfn)(struct imsg*, size_t);
89 5e11c00c 2021-03-02 op
90 5e11c00c 2021-03-02 op struct parser {
91 fc43eadd 2021-03-12 op const char *name;
92 dc5df781 2021-03-13 op char title[32+1];
93 5e11c00c 2021-03-02 op char *buf;
94 5e11c00c 2021-03-02 op size_t len;
95 5e11c00c 2021-03-02 op size_t cap;
96 5e11c00c 2021-03-02 op int flags;
97 5e11c00c 2021-03-02 op parsechunkfn parse;
98 5e11c00c 2021-03-02 op parserfreefn free;
99 5e11c00c 2021-03-02 op
100 5e11c00c 2021-03-02 op TAILQ_HEAD(, line) head;
101 5e11c00c 2021-03-02 op };
102 5e11c00c 2021-03-02 op
103 3148eeac 2021-03-13 op struct histhead {
104 3148eeac 2021-03-13 op TAILQ_HEAD(mhisthead, hist) head;
105 3148eeac 2021-03-13 op size_t len;
106 3148eeac 2021-03-13 op };
107 3148eeac 2021-03-13 op struct hist {
108 3148eeac 2021-03-13 op char h[1025];
109 3148eeac 2021-03-13 op TAILQ_ENTRY(hist) entries;
110 3148eeac 2021-03-13 op };
111 3148eeac 2021-03-13 op
112 65d9b3ca 2021-03-14 op struct ui_state {
113 452589f7 2021-03-16 op int curs_x;
114 452589f7 2021-03-16 op int curs_y;
115 452589f7 2021-03-16 op size_t line_off;
116 452589f7 2021-03-16 op size_t line_max;
117 452589f7 2021-03-16 op struct vline *current_line;
118 452589f7 2021-03-16 op size_t line_x;
119 1d08c280 2021-03-06 op
120 452589f7 2021-03-16 op short loading_anim;
121 452589f7 2021-03-16 op short loading_anim_step;
122 452589f7 2021-03-16 op struct event loadingev;
123 65d9b3ca 2021-03-14 op
124 b20a48b9 2021-03-17 op TAILQ_HEAD(vhead, vline) head;
125 65d9b3ca 2021-03-14 op };
126 65d9b3ca 2021-03-14 op
127 10346511 2021-03-17 op /*
128 10346511 2021-03-17 op * differnt types of trust for a certificate. Following
129 10346511 2021-03-17 op * gemini://thfr.info/gemini/modified-trust-verify.gmi
130 10346511 2021-03-17 op */
131 10346511 2021-03-17 op enum trust_state {
132 10346511 2021-03-17 op TS_UNKNOWN,
133 10346511 2021-03-17 op TS_UNTRUSTED,
134 10346511 2021-03-17 op TS_TRUSTED,
135 10346511 2021-03-17 op TS_VERIFIED,
136 10346511 2021-03-17 op };
137 10346511 2021-03-17 op
138 cbcc75fb 2021-03-17 op struct tofu_entry {
139 cbcc75fb 2021-03-17 op char domain[GEMINI_URL_LEN];
140 cbcc75fb 2021-03-17 op /* enough space for ``PROTO:HASH''. probably isn't a good
141 cbcc75fb 2021-03-17 op * idea thou. */
142 cbcc75fb 2021-03-17 op char hash[128+1];
143 cbcc75fb 2021-03-17 op int verified;
144 cbcc75fb 2021-03-17 op };
145 cbcc75fb 2021-03-17 op
146 5e11c00c 2021-03-02 op extern TAILQ_HEAD(tabshead, tab) tabshead;
147 5e11c00c 2021-03-02 op struct tab {
148 5e11c00c 2021-03-02 op struct parser page;
149 5e11c00c 2021-03-02 op TAILQ_ENTRY(tab) tabs;
150 5e11c00c 2021-03-02 op uint32_t id;
151 5e11c00c 2021-03-02 op uint32_t flags;
152 0972d8b2 2021-03-02 op
153 10346511 2021-03-17 op enum trust_state trust;
154 4d3785b1 2021-03-09 op struct url url;
155 2051e653 2021-03-13 op struct histhead hist;
156 2051e653 2021-03-13 op struct hist *hist_cur;
157 2051e653 2021-03-13 op size_t hist_off;
158 8af5e5ed 2021-03-08 op
159 0972d8b2 2021-03-02 op int code;
160 0972d8b2 2021-03-02 op char meta[GEMINI_URL_LEN];
161 0972d8b2 2021-03-02 op int redirect_count;
162 1d08c280 2021-03-06 op
163 65d9b3ca 2021-03-14 op struct ui_state s;
164 5e11c00c 2021-03-02 op };
165 5e11c00c 2021-03-02 op
166 4d3785b1 2021-03-09 op struct proto {
167 4d3785b1 2021-03-09 op const char *schema;
168 4d3785b1 2021-03-09 op
169 4d3785b1 2021-03-09 op /* should load the given url in the tab. Optionally, it may
170 4d3785b1 2021-03-09 op * consider the given url as relative to the one already
171 4d3785b1 2021-03-09 op * present in tab. It must set tab->urlstr to a serialized
172 4d3785b1 2021-03-09 op * human-friendly URL. */
173 4d3785b1 2021-03-09 op void (*loadfn)(struct tab*, const char*);
174 4d3785b1 2021-03-09 op };
175 4d3785b1 2021-03-09 op
176 67c8ed7f 2021-03-13 op struct kmap {
177 67c8ed7f 2021-03-13 op TAILQ_HEAD(map, keymap) m;
178 67c8ed7f 2021-03-13 op void (*unhandled_input)(void);
179 67c8ed7f 2021-03-13 op };
180 67c8ed7f 2021-03-13 op
181 67c8ed7f 2021-03-13 op struct keymap {
182 67c8ed7f 2021-03-13 op int meta;
183 67c8ed7f 2021-03-13 op int key;
184 67c8ed7f 2021-03-13 op struct kmap map;
185 67c8ed7f 2021-03-13 op void (*fn)(struct tab*);
186 67c8ed7f 2021-03-13 op
187 67c8ed7f 2021-03-13 op TAILQ_ENTRY(keymap) keymaps;
188 67c8ed7f 2021-03-13 op };
189 67c8ed7f 2021-03-13 op
190 35e1f40a 2021-03-14 op /* fs.c */
191 3a227e9a 2021-03-18 op int fs_init(void);
192 35e1f40a 2021-03-14 op int fs_main(struct imsgbuf*);
193 3a227e9a 2021-03-18 op int load_certs(struct ohash*);
194 5e11c00c 2021-03-02 op
195 5e11c00c 2021-03-02 op /* gemini.c */
196 35e1f40a 2021-03-14 op int client_main(struct imsgbuf*);
197 5e11c00c 2021-03-02 op
198 5e11c00c 2021-03-02 op /* gemtext.c */
199 5e11c00c 2021-03-02 op void gemtext_initparser(struct parser*);
200 5e11c00c 2021-03-02 op
201 cbcc75fb 2021-03-17 op /* hash.c */
202 cbcc75fb 2021-03-17 op void telescope_ohash_init(struct ohash*, unsigned int, ptrdiff_t);
203 cbcc75fb 2021-03-17 op struct tofu_entry *telescope_lookup_tofu(struct ohash*, const char*);
204 cbcc75fb 2021-03-17 op void telescope_ohash_insert(struct ohash*, struct tofu_entry*);
205 cbcc75fb 2021-03-17 op
206 2051e653 2021-03-13 op /* hist.c */
207 2051e653 2021-03-13 op void hist_clear_forward(struct histhead*, struct hist*);
208 2051e653 2021-03-13 op void hist_push(struct histhead*, struct hist*);
209 2051e653 2021-03-13 op
210 67c8ed7f 2021-03-13 op /* keymap.c */
211 67c8ed7f 2021-03-13 op int kbd(const char*);
212 67c8ed7f 2021-03-13 op const char *unkbd(int);
213 67c8ed7f 2021-03-13 op int kmap_define_key(struct kmap*, const char*, void(*)(struct tab*));
214 67c8ed7f 2021-03-13 op
215 c07ac996 2021-03-12 op /* mime.c */
216 c07ac996 2021-03-12 op int setup_parser_for(struct tab*);
217 c07ac996 2021-03-12 op
218 0972d8b2 2021-03-02 op /* pages.c */
219 0972d8b2 2021-03-02 op extern const char *about_new;
220 0972d8b2 2021-03-02 op
221 0972d8b2 2021-03-02 op #define CANNOT_FETCH 0
222 0972d8b2 2021-03-02 op #define TOO_MUCH_REDIRECTS 1
223 5cd2ebb1 2021-03-11 op #define MALFORMED_RESPONSE 2
224 c07ac996 2021-03-12 op #define UNKNOWN_TYPE_OR_CSET 3
225 0972d8b2 2021-03-02 op extern const char *err_pages[70];
226 0972d8b2 2021-03-02 op
227 3d70083d 2021-03-12 op /* parser.c */
228 3d70083d 2021-03-12 op int parser_append(struct parser*, const char*, size_t);
229 3d70083d 2021-03-12 op int parser_set_buf(struct parser*, const char*, size_t);
230 3d70083d 2021-03-12 op
231 ebdcadbf 2021-03-12 op /* sandbox.c */
232 ebdcadbf 2021-03-12 op void sandbox_network_process(void);
233 b1d4d01b 2021-03-14 op void sandbox_ui_process(void);
234 35e1f40a 2021-03-14 op void sandbox_fs_process(void);
235 ebdcadbf 2021-03-12 op
236 bcb0b073 2021-03-07 op /* telescope.c */
237 4d3785b1 2021-03-09 op void load_about_url(struct tab*, const char*);
238 4d3785b1 2021-03-09 op void load_gemini_url(struct tab*, const char*);
239 bcb0b073 2021-03-07 op void load_url(struct tab*, const char*);
240 2051e653 2021-03-13 op int load_previous_page(struct tab*);
241 2051e653 2021-03-13 op int load_next_page(struct tab*);
242 9ad4627d 2021-03-10 op void stop_tab(struct tab*);
243 740f578b 2021-03-15 op void add_to_bookmarks(const char*);
244 bcb0b073 2021-03-07 op
245 c49d61bc 2021-03-12 op /* textplain.c */
246 c49d61bc 2021-03-12 op void textplain_initparser(struct parser*);
247 c49d61bc 2021-03-12 op
248 5e11c00c 2021-03-02 op /* ui.c */
249 941b3761 2021-03-18 op int ui_init(int, const char**);
250 8af5e5ed 2021-03-08 op void ui_on_tab_loaded(struct tab*);
251 5e11c00c 2021-03-02 op void ui_on_tab_refresh(struct tab*);
252 5cd2ebb1 2021-03-11 op void ui_require_input(struct tab*, int);
253 740f578b 2021-03-15 op void ui_notify(const char*, ...) __attribute__((format(printf, 1, 2)));
254 5e11c00c 2021-03-02 op void ui_end(void);
255 5e11c00c 2021-03-02 op
256 5e11c00c 2021-03-02 op /* util.c */
257 5e11c00c 2021-03-02 op int mark_nonblock(int);
258 5c88f028 2021-03-09 op int has_prefix(const char*, const char*);
259 1304bbdd 2021-03-15 op void dispatch_imsg(struct imsgbuf*, imsg_handlerfn**, size_t);
260 5e11c00c 2021-03-02 op
261 65d9b3ca 2021-03-14 op /* wrap.c */
262 65d9b3ca 2021-03-14 op void wrap_text(struct tab*, const char*, struct line*, size_t);
263 65d9b3ca 2021-03-14 op int hardwrap_text(struct tab*, struct line*, size_t);
264 65d9b3ca 2021-03-14 op
265 5e11c00c 2021-03-02 op #endif /* TELESCOPE_H */