summaryrefslogtreecommitdiff
path: root/apps/plugins/text_viewer/tv_text_processor.h
diff options
context:
space:
mode:
Diffstat (limited to 'apps/plugins/text_viewer/tv_text_processor.h')
-rw-r--r--apps/plugins/text_viewer/tv_text_processor.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/apps/plugins/text_viewer/tv_text_processor.h b/apps/plugins/text_viewer/tv_text_processor.h
new file mode 100644
index 0000000000..3cb2a96448
--- /dev/null
+++ b/apps/plugins/text_viewer/tv_text_processor.h
@@ -0,0 +1,80 @@
1/***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
9 *
10 * Copyright (C) 2002 Gilles Roux
11 * 2003 Garrett Derner
12 * 2010 Yoshihisa Uchida
13 *
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
18 *
19 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20 * KIND, either express or implied.
21 *
22 ****************************************************************************/
23#ifndef PLUGIN_TEXT_VIEWER_TEXT_PROCESSOR_H
24#define PLUGIN_TEXT_VIEWER_TEXT_PROCESSOR_H
25
26/*
27 * initialize the text processor module
28 *
29 * [In] buf
30 * the start pointer of the buffer
31 *
32 * [In] size
33 * enabled buffer size
34 *
35 * [Out] used_size
36 * the size of the buffer which the pager uses
37 *
38 * return
39 * true initialize success
40 * false initialize failure
41 */
42bool tv_init_text_processor(unsigned char *buf, size_t bufsize, size_t *used_size);
43
44/*
45 * set the processing conditions
46 *
47 * [In] blocks
48 * total block count
49 *
50 * [In] width
51 * the block width
52 */
53void tv_set_creation_conditions(int blocks, int width);
54
55/*
56 * create the displayed text
57 *
58 * [In] src
59 * the start pointer of the buffer
60 *
61 * [In] bufsize
62 * buffer size
63 *
64 * [In] block
65 * the index of block to read text
66 *
67 * [In] is_multi
68 * true read 2 blocks
69 * false read 1 block
70 *
71 * [Out] dst
72 * the pointer of the pointer which store the text
73 *
74 * return
75 * the size of the text
76 */
77int tv_create_formed_text(const unsigned char *src, ssize_t bufsize,
78 int block, bool is_multi, const unsigned char **dst);
79
80#endif