Mercurial > sci

annotate scid/pageutil.h @ 33:1d0ddf9e6efd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 081e1c258e64
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
29
695637f1d8a7 scid: first index page in javascript
David Demelier <markand@malikania.fr>
parents: 26
diff changeset
2 * pageutil.h -- page utilities
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 29
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_PAGE_H
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_PAGE_H
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
22 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
23 * \file pageutil.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Page utilities.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
25 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
26 * This module provides convenient helpers to generate pages, it will call the
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
27 * current theme so make sure to initialize before using this module.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
28 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
29 * This module does not log messages.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
30 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
31
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #include <sys/types.h>
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #include <stdarg.h>
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 #include <stdint.h>
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
35
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 #include <kcgi.h>
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
38 #include <jansson.h>
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
39
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
40 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
41 * Render a page using the given content.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
42 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
43 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
44 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
45 * \param status the HTTP status code
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
46 * \param mime the MIME type
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
47 * \param body the body content (maybe NULL)
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
48 */
29
695637f1d8a7 scid: first index page in javascript
David Demelier <markand@malikania.fr>
parents: 26
diff changeset
49 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
50 pageutil_render(struct kreq *r, enum khttp status, enum kmime mime, const char *body);
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
51
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
52 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
53 * Render a status code page (e.g. 400).
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
54 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
55 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
56 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
57 * \param status the HTTP status code
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
58 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
59 void
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
60 pageutil_status(struct kreq *r, enum khttp status);
29
695637f1d8a7 scid: first index page in javascript
David Demelier <markand@malikania.fr>
parents: 26
diff changeset
61
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
62 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
63 * Render a page with a JSON as MIME type.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
64 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
65 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
66 * \param r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
67 * \param status the HTTP status code
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
68 * \param doc the JSON document (may be NULL)
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
69 * \warning The document will be destroyed using json_decref.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
70 */
29
695637f1d8a7 scid: first index page in javascript
David Demelier <markand@malikania.fr>
parents: 26
diff changeset
71 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
72 pageutil_json(struct kreq *r, enum khttp status, json_t *doc);
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 #endif /* !SCI_PAGE_H */